Skip to content

docs: sync README config example with scaffolded defaults #14

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

Closed
jroell wants to merge 1 commit into from
Closed

docs: sync README config example with scaffolded defaults #14

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
26 changes: 13 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,13 +69,13 @@ gg pair --coder claude --reviewer claude "refactor auth module" --review-interva
```

| Flag | Description | Default |
||------|-------------|---------|
|| `--coder` | Agent that writes code (`claude` or `codex`) | `claude` |
|| `--reviewer` | Agent that reviews (`claude` or `codex`) | `codex` |
|| `--review-interval` | How often the reviewer checks | `45s` |
|| `--max-interventions` | Max reviewer pause cycles before forcing completion | `5` |
|| `--timeout` | Total session timeout | `30m` |
|| `--yolo` / `--no-yolo` | Auto-approve agent actions | `true` |
|------|-------------|---------|
| `--coder` | Agent that writes code (`claude` or `codex`) | `claude` |
| `--reviewer` | Agent that reviews (`claude` or `codex`) | `codex` |
| `--review-interval` | How often the reviewer checks | `45s` |
| `--max-interventions` | Max reviewer pause cycles before forcing completion | `5` |
| `--timeout` | Total session timeout | `30m` |
| `--yolo` / `--no-yolo` | Auto-approve agent actions | `true` |

### What You See

Expand Down Expand Up @@ -219,11 +219,11 @@ gg init # creates the config file

```json
{
"_readme": "gitgang per-repo config. Every field is optional. CLI flags and env vars override these. Delete this file to reset to built-in defaults.",
"automerge": "ask",
"reviewer": "codex",
"timeoutMs": 600000,
"heartbeatIntervalMs": 30000,
"timeoutMs": 600000,
"timeoutMs": 1500000,
"models": {
"gemini": "gemini-3.1-pro",
"claude": "claude-opus-4-7",
Expand Down Expand Up @@ -278,10 +278,10 @@ npm test # run test suite
## 🎯 Use Cases

| Mode | Best For |
||------|----------|
|| `gg` / `gg pair` | Complex features, refactors, unfamiliar codebases — when early feedback prevents wasted work |
|| `gg -i` | Exploration, Q&A, comparing approaches, interactive code changes |
|| `gg "task"` | Simple, well-defined tasks — fire and forget |
|------|----------|
| `gg` / `gg pair` | Complex features, refactors, unfamiliar codebases — when early feedback prevents wasted work |
| `gg -i` | Exploration, Q&A, comparing approaches, interactive code changes |
| `gg "task"` | Simple, well-defined tasks — fire and forget |

## ⚠️ Important Notes

Expand Down