You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/getting-started.md
+8Lines changed: 8 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,9 +8,12 @@ Get from zero to orchestrating Claude Code sessions in **two commands**.
8
8
|---|---|---|
9
9
| Node.js | ≥ 20 |`node --version`|
10
10
| Claude Code CLI | Latest |`claude --version`|
11
+
| Claude Code auth | Logged in |`claude auth status`|
11
12
12
13
Aegis bundles `claude-agent-acp` — no tmux installation required.
13
14
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
+
14
17
## Quick Start (2 commands)
15
18
16
19
```bash
@@ -37,6 +40,10 @@ If the server is already running, `ag run` skips bootstrap and start — goes st
37
40
|`--cwd <path>`| Working directory (default: current directory) |
| `--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.
40
47
41
48
> **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.
42
49
@@ -389,6 +396,7 @@ See the [Worktree Guide](./worktree-guide.md) for detailed setup instructions.
389
396
| Problem | Solution |
390
397
|---|---|
391
398
|`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 |
392
400
|`Claude Code CLI not found`| Install Claude Code: `npm install -g @anthropic-ai/claude-code` and run `claude` to authenticate |
393
401
|`401 Unauthorized`| Set `AEGIS_AUTH_TOKEN` or include `Authorization: Bearer <token>` header |
394
402
| Session stuck on `stalled`| Send an interrupt: `curl -X POST http://localhost:9100/v1/sessions/:id/interrupt`|
0 commit comments