Quickstart

Get tinycrab running in under 5 minutes.

Prerequisites

Node.js 20 or later
An API key from OpenAI, Anthropic, or another supported provider

1. Installation

$ npm install -g tinycrab

2. Set Your API Key

# OpenAI (default)
$ export OPENAI_API_KEY=sk-xxx

# Or Anthropic
$ export ANTHROPIC_API_KEY=sk-xxx

3. Spawn an Agent

$ tinycrab spawn my-agent
# → Agent 'my-agent' spawned
# → Server running on port 9000

4. Chat with Your Agent

$ tinycrab chat my-agent "Create a hello world script"
# → [my-agent]: I've created hello.py that prints "Hello, World!"
# → (session: session-a1b2c3d4)

# Interactive mode
$ tinycrab chat my-agent -i
# → Interactive session with 'my-agent'
# → Type 'exit' to quit.
# → my-agent> _

5. Manage Agents

$ tinycrab list
# → NAME          STATUS      PORT
# → my-agent      running     9000

$ tinycrab stop my-agent
# → Agent 'my-agent' stopped

$ tinycrab cleanup my-agent
# → Agent 'my-agent' cleaned up

Documentation