Skip to main content
Use the CLI, Python, or TypeScript. All three connect to the same managed evaluation service.

Install a client

The CLI and TypeScript package use Node.js. Python requires 3.10 or newer and does not need Node.js.
For a one-off CLI command, use npx --package=@evolvingmachines/evolve evolve --help. Outside a project with Evolve installed, bare npx evolve can fetch an unrelated package.

Connect your account

1

Create an API key

Sign in to the Evolve dashboard, then open API keys and create a key.
2

Set the environment variable

Every client reads this variable. Set it in the environment where your terminal or application runs.
3

Check the connection

The result names your user, email, and key. Add --json for machine-readable output. See SDK authentication for the Python and TypeScript calls.
Evaluations spend credits: without them, a job is refused with HTTP 402 and code insufficient_credits. A read-only key used for a write returns HTTP 403 with code read_only_key. Revoke keys in the dashboard, or use the HTTP key-management endpoints.

Give your coding agent the manual

This writes the small evolve skill to ~/.codex/skills/evolve/SKILL.md. Name another target for a different agent, or omit --target to install into every supported agent home that already exists. The skill points your agent at the manual inside the CLI, which matches the installed version:
An agent that reads the web can use this site directly. Every page has a Markdown version (add .md to its address), and llms.txt lists them all.

Quick start

Run one task from the terminal.

SDKs

Create and inspect jobs from code.
Last modified on November 9, 2026