Get started
Running in a minute.
Install the CLI, connect a model provider, and hand Crayon its first task. Bring your own key — or run fully offline with Ollama.
Install
Install globally with npm (or pnpm):
npm install -g crayon-cli
# or: pnpm add -g crayon-cliPrefer not to install? Run it straight away:
npx crayon-cli@latest chatConnect a model provider
The fastest path is the setup wizard — it asks for your provider, model, and API key, then saves them to ~/.crayon/config.json:
crayon configOr set an environment variable for your provider and skip the wizard:
| Provider | Environment variable | Notes |
|---|---|---|
| Anthropic | ANTHROPIC_API_KEY | Claude models (recommended) |
| OpenAI | OPENAI_API_KEY | GPT models |
| GEMINI_API_KEY | Gemini models | |
| OpenRouter | OPENROUTER_API_KEY | Any model via OpenRouter |
| Ollama | — none — | Local & offline, no key required |
export ANTHROPIC_API_KEY="sk-ant-..."
# optional overrides:
export CRAYON_PROVIDER="anthropic"
export CRAYON_MODEL="claude-sonnet-4-6"Start coding
Open an interactive session in your project:
cd your-project
crayon chatOr fire a one-shot task and let it run:
crayon run "add a health-check endpoint and a test for it"Control how much it can do on its own with --mode (or the /mode command in chat):
- ask — confirm every edit and command (default)
- auto-edit — apply edits, confirm commands
- plan — plan only, change nothing
- auto — run freely, block dangerous commands
- bypass — no prompts (use with care)
Run offline (optional)
Point Crayon at a local Ollama server for zero-cost, fully private runs — no API key:
ollama run qwen2.5-coder:7b # pull a model once
export CRAYON_PROVIDER="ollama"
crayon chatGo further
Editor: install the VS Code extension for a chat panel with live reasoning and click-to-source citations.
Tools: connect any Model Context Protocol server to give the agent new capabilities:
crayon mcp add <name> <command> [args...]
crayon mcp listCommand reference
| crayon chat | Start an interactive agent session |
| crayon run "<task>" | Run a one-shot autonomous task |
| crayon config | Re-run the setup wizard |
| crayon init | Initialize .crayon/ and index the repo |
| crayon sessions | List saved chat sessions |
| crayon chat --resume | Resume your most recent session |
| crayon mcp add <name> <cmd> | Add an MCP server |
| crayon update | Update to the latest version |