Skip to content

Commit 9243cb9

Browse files
docs: fix Claude auth prerequisite and ag run flags (#3371)
Closes #3350, closes #3358. Documents Claude auth requirement and corrects ag run flag docs.
1 parent 44bc04e commit 9243cb9

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

docs/getting-started.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,12 @@ Get from zero to orchestrating Claude Code sessions in **two commands**.
88
|---|---|---|
99
| Node.js | ≥ 20 | `node --version` |
1010
| Claude Code CLI | Latest | `claude --version` |
11+
| Claude Code auth | Logged in | `claude auth status` |
1112

1213
Aegis bundles `claude-agent-acp` — no tmux installation required.
1314

15+
> **Before you start:** Claude Code must be authenticated. Run `claude auth status` — if it shows "Not logged in", run `claude login` first. Sessions created without Claude auth will silently produce no output. `ag doctor` also checks this for you.
16+
1417
## Quick Start (2 commands)
1518

1619
```bash
@@ -37,6 +40,10 @@ If the server is already running, `ag run` skips bootstrap and start — goes st
3740
| `--cwd <path>` | Working directory (default: current directory) |
3841
| `--port <number>` | Server port override |
3942
| `--no-stream` | Don't stream output; print curl commands instead |
43+
| `--model <provider/model>` | Override the default model for this session |
44+
| `--name <name>` | Set a display name for the session |
45+
46+
> **Note:** `ag run --help` currently shows the general help. For `ag run` flags, refer to this table.
4047
4148
> **Troubleshooting:** If `ag run` hangs without creating a session, fall back to the step-by-step setup below. It separates server start from session creation and gives clearer error output.
4249
@@ -389,6 +396,7 @@ See the [Worktree Guide](./worktree-guide.md) for detailed setup instructions.
389396
| Problem | Solution |
390397
|---|---|
391398
| `claude: command not found` | Install Claude Code: `npm install -g @anthropic-ai/claude-code` and run `claude` to authenticate |
399+
| Claude not authenticated | Run `claude login` first. Sessions created without auth produce no output. `ag doctor` checks this |
392400
| `Claude Code CLI not found` | Install Claude Code: `npm install -g @anthropic-ai/claude-code` and run `claude` to authenticate |
393401
| `401 Unauthorized` | Set `AEGIS_AUTH_TOKEN` or include `Authorization: Bearer <token>` header |
394402
| Session stuck on `stalled` | Send an interrupt: `curl -X POST http://localhost:9100/v1/sessions/:id/interrupt` |

0 commit comments

Comments
 (0)