Skip to content

Commit f8a9dc3

Browse files
docs: update documentation for v0.3.1–v0.5.2 release changes
- Add `chief update` command and automatic version check on startup - Add diff view (`d` key) and `l` key for PRD picker selection mode - Add `e` key (edit PRD from any view), `PgUp`/`PgDn`, `+`/`-` keybindings - Replace removed `--no-sound` flag with `--no-retry` flag - Fix `--max-iterations` default from hardcoded values to "Dynamic" - Add `name` and `context` arguments to `chief new` - Fix build-from-source commands to include `./cmd/chief` - Remove obsolete sound/audio references (feature removed in v0.5.0)
1 parent b544696 commit f8a9dc3

File tree

8 files changed

+110
-52
lines changed

8 files changed

+110
-52
lines changed

docs/concepts/how-it-works.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,9 @@ The TUI shows branch and directory information throughout:
116116
Autonomous doesn't mean unattended. The TUI lets you:
117117

118118
- **Start / Pause / Stop**: Press `s` to start, `p` to pause after the current story, `x` to stop immediately
119-
- **Switch projects**: Press `n` to cycle through projects, or `1-9` to jump directly
119+
- **Review diffs**: Press `d` to see the commit diff for the selected story
120+
- **Edit the PRD**: Press `e` to open the current PRD in Claude Code for refinement
121+
- **Switch projects**: Press `l` to list PRDs, `n` to create a new one, or `1-9` to jump directly
120122
- **Resume anytime**: Walk away, come back, press `s`. Chief picks up where you left off
121123
- **Merge branches**: Press `m` in the picker to merge a completed branch
122124
- **Clean worktrees**: Press `c` in the picker to remove a worktree and optionally delete the branch

docs/concepts/ralph-loop.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ The next iteration starts fresh. Claude reads the updated PRD, sees the complete
193193

194194
## Iteration Limits
195195

196-
Chief has a safety limit on iterations (default: 100). This prevents runaway loops if something goes wrong.
196+
Chief has a safety limit on iterations to prevent runaway loops. When `--max-iterations` is not specified, the limit is calculated dynamically based on the number of remaining stories plus a buffer. You can also adjust the limit at runtime with `+`/`-` in the TUI.
197197

198198
| Scenario | What Happens |
199199
|----------|--------------|

docs/guide/installation.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -61,12 +61,22 @@ This method:
6161
- Installs to `/opt/homebrew/bin/chief` (Apple Silicon) or `/usr/local/bin/chief` (Intel/Linux)
6262
- Works on macOS (Apple Silicon and Intel) and Linux (x64 and ARM64)
6363

64-
### Updating with Homebrew
64+
### Updating
65+
66+
The easiest way to update is Chief's built-in update command, which works regardless of how you installed:
67+
68+
```bash
69+
chief update
70+
```
71+
72+
If you installed via Homebrew, you can also use:
6573

6674
```bash
6775
brew update && brew upgrade chief
6876
```
6977

78+
Chief automatically checks for updates on startup and notifies you when a new version is available.
79+
7080
## Install Script
7181

7282
Download and install with a single command:
@@ -197,18 +207,18 @@ git clone https://github.com/minicodemonkey/chief.git
197207
cd chief
198208

199209
# Build the binary
200-
go build -o chief
210+
go build -o chief ./cmd/chief
201211

202212
# Optionally install to your GOPATH/bin
203-
go install
213+
go install ./cmd/chief
204214
```
205215

206216
### Build with Version Info
207217

208218
For a release-quality build with version information embedded:
209219

210220
```bash
211-
go build -ldflags "-X main.version=$(git describe --tags --always)" -o chief
221+
go build -ldflags "-X main.version=$(git describe --tags --always)" -o chief ./cmd/chief
212222
```
213223

214224
### Verify the Build
@@ -236,10 +246,10 @@ Expected output:
236246

237247
```
238248
$ chief --version
239-
chief version v0.1.0
249+
chief version vX.Y.Z
240250
241251
$ claude --version
242-
Claude Code CLI v1.0.0
252+
Claude Code vX.Y.Z
243253
```
244254

245255
::: warning Troubleshooting

docs/guide/quick-start.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -91,31 +91,38 @@ Press `s` to start the Ralph Loop. Chief will offer to create a worktree for iso
9191

9292
The TUI shows:
9393

94-
- **Tab Bar** - All your PRDs with status indicators
95-
- **Stories List** - User stories with completion status
96-
- **Story Details** - Current story's description and acceptance criteria
97-
- **Live Activity** - Real-time status updates from Claude
94+
- **Tab Bar** — All your PRDs with status indicators
95+
- **Stories List** — User stories with completion status
96+
- **Story Details** — Current story's description and acceptance criteria
97+
- **Live Activity** — Real-time status updates from Claude
98+
- **Diff View** — Press `d` to see the commit diff for the selected story
9899

99100
### Keyboard Controls
100101

101102
| Key | Action |
102103
|-----|--------|
103-
| `s` | **Start** the loop (when Ready, Paused, or Stopped) |
104+
| `s` | **Start** the loop (when Ready, Paused, Stopped, or Error) |
104105
| `p` | **Pause** the loop (finishes current iteration) |
105106
| `x` | **Stop** the loop immediately |
106107
| `t` | **Toggle** between Dashboard and Log views |
107-
| `n` | Open **PRD picker** to switch or create PRDs |
108+
| `d` | **Diff view** — show the selected story's commit diff |
109+
| `n` | Open **PRD picker** to create or switch PRDs |
110+
| `l` | Open **PRD picker** in selection mode |
111+
| `e` | **Edit** current PRD via Claude Code |
108112
| `1-9` | **Quick switch** to PRD tabs 1-9 |
109-
| `j/↓` | Navigate down (stories or scroll log) |
110-
| `k/↑` | Navigate up (stories or scroll log) |
113+
| `j/↓` | Navigate down (stories or scroll log/diff) |
114+
| `k/↑` | Navigate up (stories or scroll log/diff) |
115+
| `PgDn` / `Ctrl+D` | Page down (log/diff) |
116+
| `PgUp` / `Ctrl+U` | Page up (log/diff) |
117+
| `+`/`-` | Adjust max iterations |
111118
| `m` | **Merge** completed branch (in picker) |
112119
| `c` | **Clean** worktree (in picker) |
113120
| `,` | Open **Settings** |
114121
| `?` | Show **help** overlay |
115122
| `q` | **Quit** Chief |
116123

117124
::: info Hands-off operation
118-
Once started with `s`, Chief runs autonomously. You can watch the progress or walk away—it will complete your PRD and play a sound when done.
125+
Once started with `s`, Chief runs autonomously. You can watch the progress or walk away—it will complete your PRD while you're gone.
119126
:::
120127

121128
## What's Next?

docs/reference/cli.md

Lines changed: 67 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ chief [command] [flags]
2121
| `edit` | Open the PRD for editing |
2222
| `status` | Show current PRD progress |
2323
| `list` | List all PRDs in the project |
24+
| `update` | Update Chief to the latest version |
2425

2526
## Commands
2627

@@ -42,8 +43,8 @@ chief [name]
4243

4344
| Flag | Description | Default |
4445
|------|-------------|---------|
45-
| `--max-iterations <n>`, `-n` | Maximum loop iterations | `10` |
46-
| `--no-sound` | Disable completion sound | `false` |
46+
| `--max-iterations <n>`, `-n` | Maximum loop iterations | Dynamic |
47+
| `--no-retry` | Disable auto-retry on Claude crashes | `false` |
4748
| `--verbose` | Show raw Claude output in log | `false` |
4849

4950
**Examples:**
@@ -59,9 +60,13 @@ chief auth-system
5960
chief --max-iterations 200
6061

6162
# Combine flags
62-
chief auth-system -n 50 --no-sound
63+
chief auth-system -n 50 --verbose
6364
```
6465

66+
::: info Dynamic iteration limit
67+
When `--max-iterations` is not specified, Chief calculates a dynamic limit based on the number of remaining stories plus a buffer. You can adjust the limit at runtime with `+`/`-` in the TUI.
68+
:::
69+
6570
::: tip
6671
If your project has only one PRD, Chief auto-detects it. Pass a name when you have multiple PRDs.
6772
:::
@@ -73,9 +78,16 @@ If your project has only one PRD, Chief auto-detects it. Pass a name when you ha
7378
Create a new PRD in the current project. This command launches Claude Code with a preloaded prompt to help you define your project requirements interactively.
7479

7580
```bash
76-
chief new
81+
chief new [name] [context]
7782
```
7883

84+
**Arguments:**
85+
86+
| Argument | Description |
87+
|----------|-------------|
88+
| `name` | PRD name (optional, defaults to `main`). Must contain only letters, numbers, hyphens, and underscores. |
89+
| `context` | Additional context to pass to Claude (optional). Included in the PRD creation prompt. |
90+
7991
**How it works:**
8092

8193
1. Chief launches Claude Code with a specialized PRD-creation prompt
@@ -97,9 +109,15 @@ chief new
97109
**Examples:**
98110

99111
```bash
100-
# Create a new PRD
112+
# Create a new PRD (defaults to name "main")
101113
chief new
102114

115+
# Create a named PRD
116+
chief new auth-system
117+
118+
# Create a PRD with additional context
119+
chief new auth-system "We use Express.js with JWT tokens"
120+
103121
# Claude Code opens - describe what you want to build
104122
# Type /exit when done - Chief generates the PRD files
105123
```
@@ -204,6 +222,37 @@ chief list
204222

205223
---
206224

225+
### chief update
226+
227+
Update Chief to the latest version. Downloads and installs the newest release from GitHub.
228+
229+
```bash
230+
chief update
231+
```
232+
233+
Chief checks the GitHub releases API, compares your current version to the latest, and downloads the appropriate binary for your platform if an update is available.
234+
235+
**Examples:**
236+
237+
```bash
238+
# Update to latest version
239+
chief update
240+
241+
# Example output:
242+
# Checking for updates...
243+
# Downloading v0.5.2 (you have v0.4.0)...
244+
# Updated to v0.5.2.
245+
```
246+
247+
::: tip Automatic update check
248+
Chief performs a non-blocking version check every time you launch the TUI. If a newer version is available, you'll see a message like:
249+
```
250+
Chief v0.5.2 available (you have v0.5.1). Run 'chief update' to upgrade.
251+
```
252+
:::
253+
254+
---
255+
207256
## Keyboard Shortcuts (TUI)
208257

209258
When Chief is running, the TUI provides real-time feedback and interactive controls:
@@ -221,14 +270,16 @@ When Chief is running, the TUI provides real-time feedback and interactive contr
221270
| Key | Action |
222271
|-----|--------|
223272
| `t` | **Toggle** between Dashboard and Log views |
273+
| `d` | **Toggle** Diff view (shows the selected story's commit diff) |
224274

225275
### PRD Management
226276

227277
| Key | Action |
228278
|-----|--------|
229-
| `n` | Open **PRD picker** (switch PRDs or create new) |
279+
| `n` | Open **PRD picker** in create mode (switch PRDs or create new) |
280+
| `l` | Open **PRD picker** in selection mode (switch between existing PRDs) |
230281
| `1-9` | **Quick switch** to PRD tabs 1-9 |
231-
| `e` | **Edit** selected PRD (in picker) |
282+
| `e` | **Edit** current PRD via Claude Code (from any main view) |
232283
| `m` | **Merge** completed PRD's branch into main (in picker or completion screen) |
233284
| `c` | **Clean** worktree and optionally delete branch (in picker or completion screen) |
234285

@@ -242,12 +293,14 @@ When Chief is running, the TUI provides real-time feedback and interactive contr
242293

243294
| Key | Action |
244295
|-----|--------|
245-
| `j` / `` | Move down (stories in Dashboard, scroll in Log) |
246-
| `k` / `` | Move up (stories in Dashboard, scroll in Log) |
247-
| `Ctrl+D` | Page down (Log view) |
248-
| `Ctrl+U` | Page up (Log view) |
249-
| `g` | Jump to top (Log view) |
250-
| `G` | Jump to bottom (Log view) |
296+
| `j` / `` | Move down (stories in Dashboard, scroll in Log/Diff) |
297+
| `k` / `` | Move up (stories in Dashboard, scroll in Log/Diff) |
298+
| `Ctrl+D` / `PgDn` | Page down (Log/Diff view) |
299+
| `Ctrl+U` / `PgUp` | Page up (Log/Diff view) |
300+
| `g` | Jump to top (Log/Diff view) |
301+
| `G` | Jump to bottom (Log/Diff view) |
302+
| `+` / `=` | Increase max iterations by 5 |
303+
| `-` / `_` | Decrease max iterations by 5 |
251304

252305
### General
253306

@@ -259,7 +312,7 @@ When Chief is running, the TUI provides real-time feedback and interactive contr
259312
| `Ctrl+C` | Force quit |
260313

261314
::: tip
262-
The TUI has two main views: **Dashboard** showing stories and progress, and **Log** view streaming Claude's output in real time. Press `t` to toggle between them.
315+
The TUI has three views: **Dashboard** showing stories and progress, **Log** streaming Claude's output in real time, and **Diff** showing the commit diff for the selected story. Press `t` to toggle Dashboard/Log, or `d` to open the Diff view.
263316
:::
264317

265318
## Exit Codes

docs/reference/configuration.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,12 +83,14 @@ These settings are saved to `.chief/config.yaml` and can be changed at any time
8383

8484
| Flag | Description | Default |
8585
|------|-------------|---------|
86-
| `--max-iterations <n>`, `-n` | Loop iteration limit | `10` |
87-
| `--no-sound` | Disable completion sound | `false` |
86+
| `--max-iterations <n>`, `-n` | Loop iteration limit | Dynamic |
87+
| `--no-retry` | Disable auto-retry on Claude crashes | `false` |
8888
| `--verbose` | Show raw Claude output in log | `false` |
8989
| `--merge` | Auto-merge progress on conversion conflicts | `false` |
9090
| `--force` | Auto-overwrite on conversion conflicts | `false` |
9191

92+
When `--max-iterations` is not specified, Chief calculates a dynamic limit based on the number of remaining stories plus a buffer. You can also adjust the limit at runtime with `+`/`-` in the TUI.
93+
9294
## Claude Code Configuration
9395

9496
Chief invokes Claude Code under the hood. Claude Code has its own configuration:

docs/reference/prd-schema.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ Array of strings, each describing a requirement. Claude uses these to know when
105105

106106
### priority
107107

108-
Lower numbers = higher priority. Chief always picks the lowest-priority incomplete story.
108+
Lower numbers = higher priority. Chief always picks the incomplete story with the lowest priority number first.
109109

110110
**Range:** Positive integers, typically 1-100
111111

docs/troubleshooting/common-issues.md

Lines changed: 2 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
description: Troubleshoot common Chief issues including Claude not found, permission errors, audio problems, and loop failures.
2+
description: Troubleshoot common Chief issues including Claude not found, permission errors, worktree problems, and loop failures.
33
---
44

55
# Common Issues
@@ -34,22 +34,6 @@ claude --version
3434

3535
Chief automatically runs Claude with permission prompts disabled for autonomous operation. If you're still seeing permission issues, ensure you're running Chief (not Claude directly) and that your Claude Code installation is up to date.
3636

37-
## No Sound on Completion
38-
39-
**Symptom:** Chief completes but no sound plays.
40-
41-
**Cause:** Audio system configuration or muted output.
42-
43-
**Solution:**
44-
45-
1. Check system volume isn't muted
46-
2. Verify audio device is selected correctly
47-
3. Run with `--no-sound` if audio isn't needed:
48-
49-
```bash
50-
chief --no-sound
51-
```
52-
5337
## PRD Not Updating
5438

5539
**Symptom:** Stories stay incomplete even though Claude seems to finish.
@@ -102,7 +86,7 @@ chief --no-sound
10286

10387
**Symptom:** Chief stops with "max iterations reached" message.
10488

105-
**Cause:** Claude hasn't completed after the iteration limit (default 10).
89+
**Cause:** Claude hasn't completed after the iteration limit.
10690

10791
**Solution:**
10892

0 commit comments

Comments
 (0)