Install

The CLI is published on npm as zox-code. It requires Bun ≥ 1.2 (the bundle runs as #!/usr/bin/env bun).

Global or one-shot

bun add -g zox-code

Or with npm:

npm install -g zox-code

That installs two bins: zox and zox-code (same entry). The program still runs under Bun.

Without a global install:

bunx zox-code --model openai/gpt-4.1

You can pin a version the same way as in the README:

bun add -g zox-code@0.1.3

Provider keys

Export at least one key in the same shell that starts Zox:

export OPENAI_API_KEY=sk-...
cd /path/to/your/project
zox --model openai/gpt-4.1

If you set no keys, you still have the built-in mock/echo provider (good for wiring tests, not for coding).

Smoke test

zox --model mock/echo

You should get a session without calling a paid provider.

Prerequisites

• Bun ≥ 1.2 to run the published CLI.
• A git repo as your workspace if you want the default worktree sandbox (non-git projects fall back to host with a warning unless configured otherwise).

You do not need to clone the Zox repository for day-to-day use—install zox-code and point it at your project with --workspace (default: current directory).

Programmatic client

The typed @zox/sdk package is developed in the monorepo and is not published to npm yet. Use zox serve plus the OpenAPI contract, or clone the repo and depend on @zox/sdk from the workspace. See Server, OpenAPI, and SDK.

Next

Quickstart — ten-minute first session.