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/guide/quick-start.md
+28-22Lines changed: 28 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -48,58 +48,64 @@ chief --version
48
48
49
49
## Step 2: Create Your First PRD
50
50
51
-
Navigate to your project directory and initialize Chief:
51
+
Navigate to your project directory and create a new PRD:
52
52
53
53
```bash
54
54
cd your-project
55
55
chief new
56
56
```
57
57
58
-
<PlaceholderImagelabel="Screenshot: chief new flow"height="250px" />
58
+
This launches Claude Code with a preloaded prompt. Work with Claude to describe what you want to build—your project goals, user stories, and acceptance criteria. Claude will help structure your requirements and write the `prd.md` file.
59
59
60
-
This creates a `.chief/` directory with a sample PRD to get you started. The PRD includes:
60
+
When you're done, type `/exit` to leave Claude Code. Chief then parses `prd.md` and generates `prd.json`:
61
61
62
-
-`prd.md` - Human-readable project requirements
63
-
-`prd.json` - Machine-readable user stories for Chief to execute
62
+
-`prd.md` - Human-readable project requirements (written by Claude)
63
+
-`prd.json` - Machine-readable user stories for Chief to execute (generated by Chief)
64
64
65
-
::: tip Customize your PRD
66
-
Open `.chief/prds/default/prd.md` in your editor to write your own user stories. Chief will parse it into `prd.json`automatically.
65
+
::: tip Iterating on your PRD
66
+
Run `chief edit` to reopen Claude Code and refine your `prd.md`. Chief will regenerate `prd.json`when you `/exit`.
67
67
:::
68
68
69
-
## Step 3: Run the Loop
69
+
## Step 3: Launch the TUI
70
70
71
-
Start the autonomous loop:
71
+
Launch Chief's Terminal User Interface:
72
72
73
73
```bash
74
74
chief
75
75
```
76
76
77
-
That's it! Chief takes over from here.
77
+
This opens the TUI dashboard in **Ready** state. The loop doesn't start automatically—you control when it begins.
78
78
79
-
## Step 4: Watch It Work
79
+
## Step 4: Start the Loop
80
80
81
-
Chief launches a beautiful TUI (Terminal User Interface) that shows:
81
+
Press `s` to start the Ralph Loop. Chief will begin working through your stories automatically.
82
82
83
-
-**Current Story** - Which user story is being implemented
84
-
-**Live Output** - Real-time streaming from Claude
85
-
-**Progress** - How many stories are complete vs remaining
Copy file name to clipboardExpand all lines: docs/reference/cli.md
-2Lines changed: 0 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -254,8 +254,6 @@ When Chief is running, the TUI provides real-time feedback and interactive contr
254
254
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.
0 commit comments