Skip to content

Commit 47086c1

Browse files
committed
docs(readme): fix cold-start quick-start sequence — set API key before prompt, add claw doctor step
The previous quick start jumped from 'cargo build' to 'claw prompt' without showing the required auth step or the health-check command. A user following it linearly would fail because the prompt needs an API key. Changes: - Numbered steps: build -> set ANTHROPIC_API_KEY -> claw doctor -> prompt - Windows note updated to show cargo run form as alternative - Added explicit NOTE that Claude subscription login is not supported (pre-empts #claw-code FAQ) Source: cold-start friction observed from mezz/mukduk and kapcomunica in #claw-code 2026-04-09.
1 parent e579902 commit 47086c1

1 file changed

Lines changed: 13 additions & 11 deletions

File tree

README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -49,25 +49,27 @@ The canonical implementation lives in [`rust/`](./rust), and the current source
4949
> **`cargo install clawcode` will not work** — this package is not published on crates.io. Build from source as shown below.
5050
5151
```bash
52+
# 1. Clone and build
5253
git clone https://github.com/ultraworkers/claw-code
5354
cd claw-code/rust
5455
cargo build --workspace
55-
./target/debug/claw --help
56-
./target/debug/claw prompt "summarize this repository"
57-
```
5856

59-
> [!NOTE]
60-
> **Windows (PowerShell):** the binary is `claw.exe`, not `claw`. Use `.\target\debug\claw.exe` or just run `cargo run -- --help` to skip the path lookup.
57+
# 2. Set your API key (Anthropic API key — not a Claude subscription)
58+
export ANTHROPIC_API_KEY="sk-ant-..."
6159

62-
Authenticate with either an API key or the built-in OAuth flow:
60+
# 3. Verify everything is wired correctly
61+
./target/debug/claw doctor
6362

64-
```bash
65-
export ANTHROPIC_API_KEY="sk-ant-..."
66-
# or
67-
cd rust
68-
./target/debug/claw login
63+
# 4. Run a prompt
64+
./target/debug/claw prompt "say hello"
6965
```
7066

67+
> [!NOTE]
68+
> **Windows (PowerShell):** the binary is `claw.exe`, not `claw`. Use `.\target\debug\claw.exe` or run `cargo run -- prompt "say hello"` to skip the path lookup.
69+
70+
> [!NOTE]
71+
> **Auth:** claw requires an **API key** (`ANTHROPIC_API_KEY`, `OPENAI_API_KEY`, etc.) — Claude subscription login is not a supported auth path.
72+
7173
Run the workspace test suite:
7274

7375
```bash

0 commit comments

Comments
 (0)