gsd-pi 0.1.1 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +29 -21
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -118,49 +118,57 @@ The wizard is the on-ramp. Auto mode is the highway.
|
|
|
118
118
|
|
|
119
119
|
## Getting Started
|
|
120
120
|
|
|
121
|
-
### Install
|
|
121
|
+
### Install and run
|
|
122
122
|
|
|
123
123
|
```bash
|
|
124
124
|
npm install -g gsd-pi
|
|
125
|
-
```
|
|
126
|
-
|
|
127
|
-
Requires Node.js ≥ 20.6.0. Installs Chromium via Playwright for browser-based verification (non-fatal if it fails).
|
|
128
|
-
|
|
129
|
-
### First Run
|
|
130
|
-
|
|
131
|
-
```bash
|
|
132
125
|
cd your-project
|
|
133
126
|
gsd
|
|
134
127
|
```
|
|
135
128
|
|
|
136
|
-
|
|
137
|
-
- **Brave Search** — for web research during planning
|
|
138
|
-
- **Context7** — for up-to-date library documentation
|
|
139
|
-
- **Jina** — for web page content extraction
|
|
129
|
+
That's it. GSD walks you through describing what you want to build, creates a roadmap, and starts working. When you're ready to let it run autonomously:
|
|
140
130
|
|
|
141
|
-
|
|
131
|
+
```
|
|
132
|
+
/gsd auto
|
|
133
|
+
```
|
|
142
134
|
|
|
143
|
-
|
|
135
|
+
Walk away. Come back to a built project with clean git history.
|
|
144
136
|
|
|
145
|
-
The
|
|
137
|
+
### The two-terminal workflow
|
|
146
138
|
|
|
147
|
-
|
|
139
|
+
GSD is designed for you to keep working while it builds. Open two terminals in the same project:
|
|
140
|
+
|
|
141
|
+
**Terminal 1 — auto mode (let it run)**
|
|
142
|
+
```bash
|
|
143
|
+
gsd
|
|
148
144
|
/gsd auto
|
|
149
145
|
```
|
|
150
146
|
|
|
151
|
-
|
|
147
|
+
**Terminal 2 — steer while it works**
|
|
148
|
+
```bash
|
|
149
|
+
gsd
|
|
150
|
+
/gsd discuss # talk through architecture decisions
|
|
151
|
+
/gsd status # check progress
|
|
152
|
+
/gsd queue # queue the next milestone
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
Auto mode reads state from `.gsd/` files on disk. Your discussions and decisions in terminal 2 are picked up automatically at the next phase boundary. You don't need to stop auto mode to influence what it does next.
|
|
156
|
+
|
|
157
|
+
### First launch
|
|
158
|
+
|
|
159
|
+
On first run, GSD prompts for optional API keys (Brave Search, Context7, Jina) for web research and documentation tools. All optional — press Enter to skip. Keys are stored in `~/.gsd/agent/auth.json`.
|
|
152
160
|
|
|
153
161
|
### Commands
|
|
154
162
|
|
|
155
163
|
| Command | What it does |
|
|
156
164
|
|---------|-------------|
|
|
157
165
|
| `/gsd` | Contextual wizard — reads state, shows what's next |
|
|
158
|
-
| `/gsd auto` |
|
|
166
|
+
| `/gsd auto` | Autonomous mode — researches, plans, executes, commits, repeats |
|
|
159
167
|
| `/gsd stop` | Stop auto mode gracefully |
|
|
160
|
-
| `/gsd
|
|
168
|
+
| `/gsd discuss` | Discuss architecture and decisions (works alongside auto mode) |
|
|
169
|
+
| `/gsd status` | Progress dashboard |
|
|
161
170
|
| `/gsd queue` | Queue future milestones (safe during auto mode) |
|
|
162
|
-
| `/gsd
|
|
163
|
-
| `/gsd prefs` | Manage skill preferences (global/project) |
|
|
171
|
+
| `/gsd prefs` | Model selection, timeouts, budget ceiling |
|
|
164
172
|
| `/gsd doctor` | Validate `.gsd/` integrity, find and fix issues |
|
|
165
173
|
| `Ctrl+Alt+G` | Toggle dashboard overlay |
|
|
166
174
|
|