ZCode Agent Kit

English (original) · Deutsch · Español · 日本語 · 简体中文

Use your ZCode account with the coding assistant you already use.

The kit runs locally; model requests go to ZCode.

Keep your coding assistant. Use your existing ZCode models and quota/tokens through a local connection.

Optional account rotation: The installer asks "Do you want to activate the Account Rotator feature? [y/n]". With y, the current login is imported and later zcode-kit auth login zai logins are saved as additional accounts. Signing in again updates the same account. Enable later with zcode-kit accounts enable; inspect saved accounts with zcode-kit accounts. See the account rotator documentation.

The path: prepare your account → install the kit → Use GLM-5.3(-flash) / start working.

Step 1 — Check what you need

• ZCode Desktop, signed in to your own account with available model quota.
• Node.js 20 or newer. Check with node --version in a new terminal.
• A coding assistant installed separately. The kit connects it to ZCode.

Step 2 — Install the kit once

Choose the release installer or npm below. The release installer sets up detected assistants automatically, so there is no separate setup command to run afterward.

The installer shows four numbered stages, compact assistant results and a connection check. Detailed setup output is saved to the displayed install.log; set ZCODE_KIT_VERBOSE=1 for full output and NO_COLOR=1 for plain text. Interactive installs require y or n for Account Rotator. For unattended installs, set ZCODE_KIT_ACCOUNT_ROTATOR=y or n; without an explicit answer the existing setting is preserved. A failed connection check remains a warning even when installation succeeds.

Before you run the installer: it downloads and executes a script, changes configuration for detected assistants, and may register MCP tools. Setup also attempts a small model request that can use quota. Changes are recorded, but a later failure can leave earlier changes in place. Inspect the installer if required by your security policy.

Windows — PowerShell, without administrator rights:

irm https://github.com/ZepiGit/ZCode-Agent-Kit/releases/latest/download/install.ps1 | iex

macOS / Linux — POSIX terminal:

curl -fsSL https://github.com/ZepiGit/ZCode-Agent-Kit/releases/latest/download/install.sh | sh

Run from any directory. No clone is needed. The installer runs setup and can install Bun if it is missing. On Windows, use PowerShell—not Git Bash or WSL.

Install locations and macOS/Linux prerequisites

Defaults: %LOCALAPPDATA%\zcode-agent-kit on Windows; $HOME/.local/share/zcode-agent-kit on macOS/Linux. Keep this folder separate from your working projects. Never point an installer at your home folder or source checkout: updates replace files at the destination.

macOS/Linux also need curl, tar, and a SHA-256 utility; Bun bootstrap needs unzip, and updates need rsync. Current live-client validation is Windows-focused; see the dated support matrix.

Alternative — npm (Windows, macOS and Linux):

Requires Node.js 20+ and Bun already installed and available in your terminal (bun --version; tested with Bun 1.4.2).

npm install -g zcode-agent-kit@latest
zcode-kit setup --harness auto --installer

npm installs the zcode-kit and zcode-agent-kit commands. The second command installs the kit's dependencies, configures detected assistants and asks the Account Rotator y/n question. Run it after installing the npm package. Use one installation method to keep your command, configuration and proxy tied to the same kit copy.

Step 3 — Use GLM-5.3(-flash) in your harness of choice

Open a new terminal and run zcode-kit help. Then open a terminal inside your own project, not the kit folder. Choose the assistant you installed:

OMP:

omp -p --model zcode/glm-5.3-flash "Reply with ok"

Claude Code:

zcode-kit run claude-code -- -p "Reply with ok" --model glm-5.3-flash

Codex:

zcode-kit run codex -- exec "Reply with ok" -m glm-5.3-flash

These commands start/check the proxy automatically. A reply of ok confirms the first model call. A successful setup message alone does not.

Got the reply? Your account, proxy, and selected assistant worked together for that request. You can now use that assistant in your project.

No reply? Use the checks under “Get help” below; reinstalling will not fix an exhausted quota.

Step 4 — Use it in your project

For an interactive OMP session:

omp --model zcode/glm-5.3

For an interactive Claude Code session:

zcode-kit run claude-code -- --model glm-5.3

Choose glm-5.3 for text, or glm-5.3-flash for text and images. Image support also depends on your assistant. An optional MCP bridge provides tools from your installed ZCode runtime; registering it is not the same as connecting a model.

Other assistants and integration limits

Assistant	What to do after setup
OpenCode	Run zcode-kit run opencode -- . and select a ZCode model.
Aider	Run zcode-kit run aider -- --model openai/glm-5.3-flash.
pi	Start the proxy manually, then run pi --model zcode/glm-5.3.
Goose	Start the proxy manually, then run goose session --provider zcode.
Continue	Open/configure Continue first. Run zcode-kit integrate continue, start the proxy, then select the model in the UI.
Cline / Kilo Code	Copy the generated values into the extension UI and start the proxy. Setup creates generated/cline-zcode-values.md or generated/kilo-zcode-values.md inside a release installation.

Run OMP directly, not through zcode-kit run. Only Claude Code, Codex, Aider, and OpenCode have kit launchers. Codex uses an isolated profile; your usual personal settings and skills do not automatically carry over. Claude Code routing is community compatibility. An adapter is not a guarantee that every client/version has been live-tested.

See assistant-specific documentation and the support matrix.

Start or stop the proxy manually

For the default release-installer location only:

PowerShell:

node (Join-Path $env:LOCALAPPDATA 'zcode-agent-kit/proxy/zcode-proxy-manager.mjs') start

macOS/Linux:

node "$HOME/.local/share/zcode-agent-kit/proxy/zcode-proxy-manager.mjs" start

Replace start with status, logs 50, or stop as needed. Stopping interrupts connected clients. For a custom location, use that installation's absolute path. These default paths do not apply to npm installs.

Get help

zcode-kit doctor
zcode-kit auth status

• Command not found: reopen the terminal. For release installs, check that %LOCALAPPDATA%\Microsoft\WindowsApps (Windows) or $HOME/.local/bin (macOS/Linux) is on PATH.
• No model reply: check the Desktop login and available quota. Start the proxy if your assistant does not start it. Local health does not prove model access.
• 401 or occupied port: check for another kit installation. Do not delete keys or kill an unknown process.
• Setup partly failed: read the printed rollback command before trying again. Earlier changes may still exist.

Before you use real project data

Keep the proxy on localhost and never share .proxykey, credentials, or generated configuration files.

Read the security policy: the managed proxy can execute vendor CAPTCHA JavaScript without an OS sandbox. It remains loopback-only and bearer-authenticated, but those controls are not process isolation. This does not bypass account restrictions or guarantee that every challenge succeeds.

Update or remove the kit

Update:

• Release installation: rerun the same release installer using the same dedicated destination. Remove an old ZCODE_KIT_VERSION pin if you want the latest version.
• npm installation: run npm install -g zcode-agent-kit@latest, then zcode-kit setup --harness auto --installer from that npm installation.

Keep the same installation method when updating.

Remove integrations: stop your proxy using the manager command above with stop, then run zcode-kit uninstall. This leaves the installation folder, dependencies, logs, proxy keys, and shared credentials behind; it does not log you out of Desktop. Inspect leftover files before deleting anything.

For an npm installation, remove the global package afterward with npm uninstall -g zcode-agent-kit.

More information

Assistant guides · Support matrix · Security policy · Report a problem · Licensing and bundled components