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
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)
Copy file name to clipboardExpand all lines: docs/concepts/ralph-loop.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -193,7 +193,7 @@ The next iteration starts fresh. Claude reads the updated PRD, sees the complete
193
193
194
194
## Iteration Limits
195
195
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.
Copy file name to clipboardExpand all lines: docs/reference/cli.md
+67-14Lines changed: 67 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,6 +21,7 @@ chief [command] [flags]
21
21
|`edit`| Open the PRD for editing |
22
22
|`status`| Show current PRD progress |
23
23
|`list`| List all PRDs in the project |
24
+
|`update`| Update Chief to the latest version |
24
25
25
26
## Commands
26
27
@@ -42,8 +43,8 @@ chief [name]
42
43
43
44
| Flag | Description | Default |
44
45
|------|-------------|---------|
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`|
47
48
|`--verbose`| Show raw Claude output in log |`false`|
48
49
49
50
**Examples:**
@@ -59,9 +60,13 @@ chief auth-system
59
60
chief --max-iterations 200
60
61
61
62
# Combine flags
62
-
chief auth-system -n 50 --no-sound
63
+
chief auth-system -n 50 --verbose
63
64
```
64
65
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
+
65
70
::: tip
66
71
If your project has only one PRD, Chief auto-detects it. Pass a name when you have multiple PRDs.
67
72
:::
@@ -73,9 +78,16 @@ If your project has only one PRD, Chief auto-detects it. Pass a name when you ha
73
78
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.
74
79
75
80
```bash
76
-
chief new
81
+
chief new [name] [context]
77
82
```
78
83
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
+
79
91
**How it works:**
80
92
81
93
1. Chief launches Claude Code with a specialized PRD-creation prompt
@@ -97,9 +109,15 @@ chief new
97
109
**Examples:**
98
110
99
111
```bash
100
-
# Create a new PRD
112
+
# Create a new PRD (defaults to name "main")
101
113
chief new
102
114
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
+
103
121
# Claude Code opens - describe what you want to build
104
122
# Type /exit when done - Chief generates the PRD files
105
123
```
@@ -204,6 +222,37 @@ chief list
204
222
205
223
---
206
224
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
+
207
256
## Keyboard Shortcuts (TUI)
208
257
209
258
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
221
270
| Key | Action |
222
271
|-----|--------|
223
272
|`t`|**Toggle** between Dashboard and Log views |
273
+
|`d`|**Toggle** Diff view (shows the selected story's commit diff) |
224
274
225
275
### PRD Management
226
276
227
277
| Key | Action |
228
278
|-----|--------|
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) |
230
281
|`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) |
232
283
|`m`|**Merge** completed PRD's branch into main (in picker or completion screen) |
233
284
|`c`|**Clean** worktree and optionally delete branch (in picker or completion screen) |
234
285
@@ -242,12 +293,14 @@ When Chief is running, the TUI provides real-time feedback and interactive contr
242
293
243
294
| Key | Action |
244
295
|-----|--------|
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 |
251
304
252
305
### General
253
306
@@ -259,7 +312,7 @@ When Chief is running, the TUI provides real-time feedback and interactive contr
259
312
|`Ctrl+C`| Force quit |
260
313
261
314
::: 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.
| `--force` | Auto-overwrite on conversion conflicts | `false` |
91
91
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
+
92
94
## Claude Code Configuration
93
95
94
96
Chief invokes Claude Code under the hood. Claude Code has its own configuration:
Copy file name to clipboardExpand all lines: docs/troubleshooting/common-issues.md
+2-18Lines changed: 2 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
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.
3
3
---
4
4
5
5
# Common Issues
@@ -34,22 +34,6 @@ claude --version
34
34
35
35
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.
36
36
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
-
53
37
## PRD Not Updating
54
38
55
39
**Symptom:** Stories stay incomplete even though Claude seems to finish.
@@ -102,7 +86,7 @@ chief --no-sound
102
86
103
87
**Symptom:** Chief stops with "max iterations reached" message.
104
88
105
-
**Cause:** Claude hasn't completed after the iteration limit (default 10).
89
+
**Cause:** Claude hasn't completed after the iteration limit.
0 commit comments