Setup guide
From download to your first task.
Six short steps. You need a Windows PC and, for the AI itself, about $5 of credit. Web search has a free monthly allowance.
- A 64-bit Windows PC
- An OpenRouter account with $5 of credit
- A free Tavily key, for web search
Install Zhiyin
- Download the installer (185 MB), or take it from the newest release on the Releases page.
- Open the downloaded file. Windows shows “Windows protected your PC”, because the installer is not code-signed yet. Select More info, then Run anyway.
- Follow the installer's steps.
- When Zhiyin first opens, it asks what you plan to use it for. Select the cards that fit, then Make it yours, or Start exploring to skip.
Windows protected your PC
Microsoft Defender SmartScreen prevented an unrecognized app from starting.
More info
App: Zhiyin-Setup-0.1.0-alpha.1.exe
Connect an AI model through OpenRouter
The thinking behind Zhiyin is done by an AI model, which runs on a company's servers. OpenRouter gives you access to many AI models from different companies with one account. You buy credit in advance, and each request Zhiyin sends uses a little of it, depending on the model.
An API key is like a password that lets Zhiyin use your OpenRouter account.
- Create an account at openrouter.ai.
- Add credit on the Credits page. $5 is enough to start.
- In Zhiyin, open the Model page: select ••• next to Your preferences at the bottom of the sidebar, then Model. Or press Ctrl + ,.
-
Select Add a key.
Get a key on OpenRouter opens the page
where keys are made. Create one there and copy it: it starts
with
sk-or-v1-. - Paste it under Paste your key and select Save key. Zhiyin keeps it in Windows Credential Manager, where Windows keeps passwords, and sends it only to OpenRouter.
- Choose a model in the list, then select Save at the top of the page. Leave Any provider ticked, as the page recommends.
Reading the prices
Each model shows two prices per million tokens: what Zhiyin sends (“in”) and what the model writes (“out”). A token is a small piece of a word. Order by and filters such as Lower cost help you compare.
Buying credit
One purchase is between $5 and $25,000. Paying by card adds a 5.5% fee, at least $0.80. Unused credit may expire 365 days after you buy it.
Free models
Models whose name ends in “(free)” cost nothing, within limits: 50 requests a day, or 1,000 a day once you have bought $10 of credit, and 20 a minute. One task can take many requests, so $5 of credit is the simpler start.
Prices and limits checked on 8 October 2026.
Choose a folder
Zhiyin works in one folder at a time, and reads the files in it without asking. For a first try, a new empty folder works well.
- In the message box at the bottom of the window, select Choose a folder.
- Select Choose a folder… and pick the folder in the window that opens. The same button switches folders later.
Turn on plugins
A plugin adds know-how and tools for one kind of work. Select Plugins at the top of the sidebar, select a plugin, and use the switch beside its name to turn it on or off. The cards you chose on the first screen turned on the matching plugins. A plugin that is on is used only when a task needs it.
-
Full-Stack Software Engineering
Designs, builds, tests and reviews software, with Git, a browser for testing pages, and GitHub.
-
Technical & Academic Publishing
Writes and typesets papers and reports with sound citations, compiles them to PDF, and finds research papers on alphaXiv.
-
Data Science & Business Intelligence
Explores, cleans and explains data, in a Python environment of its own.
-
Deep Research & Synthesis
Researches a question across many sources and writes a report with citations, using Tavily web search.
Under Connectors, a plugin lists the services and programs it uses. One that needs a program, such as the Python environment, shows Set up: select it, then Install, and Zhiyin downloads what it needs.
Add web search, and other services
A connector to an online service needs its own key, made on that service's website. Each one is optional, but web search is the one most tasks benefit from.
Tavily, for web search
Free · no card needed
Tavily is what lets Zhiyin search the web, through the Deep Research & Synthesis plugin. Its free plan gives 1,000 credits every month, with no credit card required. A basic search uses 1 credit and an advanced search 2.
- Sign up at tavily.com.
- Copy your API key from your dashboard at app.tavily.com.
- In Zhiyin, open Plugins, select Deep Research & Synthesis, and turn it on if it is off.
- Under Connectors, select Settings or Set up next to Tavily.
- If the window asks How Zhiyin gets access, choose Paste an access token.
- Paste the key into the API key box and select Save token. Zhiyin checks it and shows Connected.
The same window offers Sign in with an account too, which opens Tavily's sign-in page in your browser, with nothing to copy.
GitHub, for software work
In Full-Stack Software Engineering, GitHub works with your repositories, issues and pull requests, using a personal access token: a key with the permissions you choose. With the plugin on, select Set up or Settings next to GitHub, then Open GitHub to make one; the window says which permissions to give it. Paste the token and select Save token.
alphaXiv, for research papers
In Technical & Academic Publishing, alphaXiv finds research papers and reads their full text. With the plugin on, open alphaXiv's window the same way. Choose Sign in with an account, or Paste an access token to use an API key made under Settings > API Keys on alphaxiv.org.
Tavily's free plan checked on 8 October 2026.
Give it a task
Type what you need in the message box and press Enter. New task in the sidebar, or Ctrl + N, starts another conversation.
When it asks
Before Zhiyin changes a file, runs a command or uses a connector, it asks, showing what the action is, what it can do, and the exact command or the files that change. Select a file to see the change line by line. Zhiyin says marks the AI's own explanation, which can be wrong, so check what will run.
- Allow once
- This action runs.
- Deny
- It does not run. You can tell Zhiyin what to do instead, then select Confirm denial.
- Allow for this conversation
- Offered for changes to files in one subfolder and for one connector tool: what it covers runs without asking for the rest of the conversation. To take it back, select ••• next to the conversation in the sidebar, then Permissions, then Revoke.
Deleting a file, running a shell command and running Python always ask.
What it cost
Select ••• next to Your preferences, then Usage. The page shows what OpenRouter reported each request cost, by day and by conversation.
How much it keeps in mind
The small ring in the message box shows how much of the conversation Zhiyin keeps in mind. Select it to choose Low, Medium (the default) or Ultra: a larger budget keeps more of a long conversation and costs more per request. Compact summarises older messages to save room.
If something goes wrong
Zhiyin says what happened, with a button for the next step.
- “Add an OpenRouter API key on the Model page” or “OpenRouter rejected the API key”
- Select Update API key and paste a key.
- “Choose a model on the Model page”
- Select Choose a model.
- “The OpenRouter account is out of credits”
- Select Add OpenRouter credits, add credit, then select Try again.
- A connector's window says the service refused the saved key
- Make a new key on the service's site and paste it there.
- The Plugins page says “Shell commands are unavailable”
- Select Get Git for Windows, install it, then select Check again.
Still stuck? Report a problem on GitHub or write to contact@zhiyinagent.app.