Skip to content

docs: fix Claude auth prerequisite (#3350) and ag run flags (#3358) #3371

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aegis-gh-agent merged 1 commit into from
May 14, 2026
Merged

docs: fix Claude auth prerequisite (#3350) and ag run flags (#3358) #3371

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,12 @@ Get from zero to orchestrating Claude Code sessions in **two commands**.
|---|---|---|
| Node.js | ≥ 20 | `node --version` |
| Claude Code CLI | Latest | `claude --version` |
| Claude Code auth | Logged in | `claude auth status` |

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

> **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.

## Quick Start (2 commands)

```bash
Expand All @@ -37,6 +40,10 @@ If the server is already running, `ag run` skips bootstrap and start — goes st
| `--cwd <path>` | Working directory (default: current directory) |
| `--port <number>` | Server port override |
| `--no-stream` | Don't stream output; print curl commands instead |
| `--model <provider/model>` | Override the default model for this session |
| `--name <name>` | Set a display name for the session |

> **Note:** `ag run --help` currently shows the general help. For `ag run` flags, refer to this table.

> **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.

Expand Down Expand Up @@ -389,6 +396,7 @@ See the [Worktree Guide](./worktree-guide.md) for detailed setup instructions.
| Problem | Solution |
|---|---|
| `claude: command not found` | Install Claude Code: `npm install -g @anthropic-ai/claude-code` and run `claude` to authenticate |
| Claude not authenticated | Run `claude login` first. Sessions created without auth produce no output. `ag doctor` checks this |
| `Claude Code CLI not found` | Install Claude Code: `npm install -g @anthropic-ai/claude-code` and run `claude` to authenticate |
| `401 Unauthorized` | Set `AEGIS_AUTH_TOKEN` or include `Authorization: Bearer <token>` header |
| Session stuck on `stalled` | Send an interrupt: `curl -X POST http://localhost:9100/v1/sessions/:id/interrupt` |
Expand Down
Loading