Skip to content

Install Zeroshot

Install the zeroshot command through its npm delivery package, which requires Node.js 18 or newer. The installer selects the release target declared for the current system and checks the downloaded archive against SHA256SUMS before writing the native executable.

npm install --global @the-open-engine-company/zeroshot
zeroshot version

Release builds cover Linux x64 and arm64, macOS x64 and arm64, and Windows x64. Node.js is only an installer dependency; the command itself is a Rust executable.

Prepare a local run

Run Zeroshot from a Git worktree, and install the agent harness named by the runtime plan:

  • install and sign in to Codex for "harness": "codex";
  • install and sign in to Claude Code for "harness": "claude";
  • install GitHub Copilot CLI 1.0.85 for "harness": "copilot" with "provider": "github".

Provider credentials can come from the current environment or the private Zeroshot connection store. The command below prompts without echo and keeps the value out of runtime JSON:

zeroshot connection set openai --field OPENAI_API_KEY

Use openrouter, anthropic, bedrock, or gateway as the connection key when the runtime declares that provider. Runtimes and connections lists the default field names and explains the separation.

Other installation paths

Each GitHub release includes native archives and SHA256SUMS; archive names contain the release version and target triple.

The Python SDK requires Python 3.11 or newer and ships the matching executable inside each platform wheel:

python -m pip install the-open-engine-zeroshot

For a long-running target, use ghcr.io/the-open-engine/zeroshot-target. See the targets guide for a Docker setup bound to loopback.

Validate and run a first task after installation.

GitHub Copilot

Copilot uses your GitHub user identity and Copilot entitlement. Store a user OAuth token or fine-grained personal token with Copilot Requests permission in the github connection's COPILOT_GITHUB_TOKEN field. A GitHub App installation token is not the user-backed route. The token stays in private RPC and is excluded from agent tool environments.

{"harness":"copilot","provider":"github","model":"auto"}

Model IDs pass unchanged to Copilot. Zeroshot uses headless RPC schema output and validates each response locally, allowing at most two correction turns in the same session. Install the pinned CLI version above; the target image already includes it.

Hosted connection resolvers may additionally declare COPILOT_GITHUB_TOKEN_EXPIRES_AT (Unix seconds). Copilot then requests credentials through the resolver throughout a long execution. The resolver must return a refreshed token with more than one hour remaining. Static tokens without expiry metadata are supplied once when each provider process starts.