forgehive 0.7.9 → 0.8.1
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 +140 -11
- package/dist/cli.js +1127 -195
- package/docs/user-guide.md +87 -2
- package/package.json +1 -1
package/docs/user-guide.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# forgehive — User Guide
|
|
2
2
|
|
|
3
|
-
> Version 0.
|
|
3
|
+
> Version 0.8.0 · [npm](https://www.npmjs.com/package/forgehive) · `npm install -g forgehive`
|
|
4
4
|
|
|
5
5
|
forgehive (`fh`) gives Claude Code persistent memory about your project. Without it, Claude forgets everything between sessions — your stack, your conventions, your decisions. With it, Claude opens every session already knowing your codebase.
|
|
6
6
|
|
|
@@ -17,7 +17,7 @@ Requires **Node.js ≥ 18** and **Claude Code** (`claude` CLI). Installs two ali
|
|
|
17
17
|
Verify:
|
|
18
18
|
|
|
19
19
|
```bash
|
|
20
|
-
fh --version # prints 0.
|
|
20
|
+
fh --version # prints 0.8.0
|
|
21
21
|
fh --help # full command reference
|
|
22
22
|
```
|
|
23
23
|
|
|
@@ -63,6 +63,7 @@ my-project/
|
|
|
63
63
|
adrs/ ← Architecture Decision Records
|
|
64
64
|
stories/ ← story cards (US-N.md)
|
|
65
65
|
epics/ ← epic cards (EPC-N.md)
|
|
66
|
+
prds/ ← Product Requirements Documents (PRD-N.md)
|
|
66
67
|
velocity.md ← sprint velocity history
|
|
67
68
|
skills/expert/ ← 16 preinstalled expert skills
|
|
68
69
|
AGENTS.md
|
|
@@ -196,6 +197,7 @@ Lightweight agile tracking inside `.forgehive/memory/`:
|
|
|
196
197
|
```bash
|
|
197
198
|
# Epics
|
|
198
199
|
fh epic create "User Authentication" --goal "Users can log in securely"
|
|
200
|
+
fh epic create "User Authentication" --prd PRD-1 # link to a PRD
|
|
199
201
|
fh epic list
|
|
200
202
|
fh epic show EPC-1
|
|
201
203
|
|
|
@@ -216,6 +218,83 @@ In a Claude Code session, run `/fh-sprint` to let Claude read the backlog and ve
|
|
|
216
218
|
|
|
217
219
|
---
|
|
218
220
|
|
|
221
|
+
### GitHub Integration
|
|
222
|
+
|
|
223
|
+
Connect forgehive to GitHub to sync Issues as Story cards and pull PR context.
|
|
224
|
+
|
|
225
|
+
```bash
|
|
226
|
+
fh github setup # interactive: GitHub token + owner/repo → stored in ~/.forgehive/credentials.json
|
|
227
|
+
fh github sync # fetch open Issues → create Story cards (idempotent, skips already-synced)
|
|
228
|
+
fh github pr 42 # fetch PR #42 metadata + changed files → .forgehive/github-pr-42.md
|
|
229
|
+
```
|
|
230
|
+
|
|
231
|
+
**Setup is a one-time step.** `fh github setup` prompts for a personal access token (stored at `~/.forgehive/credentials.json`) and the repository in `owner/repo` format (stored at `.forgehive/github.yaml`).
|
|
232
|
+
|
|
233
|
+
**Issue sync** creates one Story card per open GitHub Issue. It's idempotent — run it multiple times without duplicating cards. Already-synced issues (detected by `GitHub: #N` in the story file) are skipped.
|
|
234
|
+
|
|
235
|
+
**PR context** writes a `.forgehive/github-pr-N.md` file with the PR title, body, author, and full list of changed files — useful to share with a Review Party:
|
|
236
|
+
|
|
237
|
+
```bash
|
|
238
|
+
fh github pr 42
|
|
239
|
+
fh party run review # Kai + Sam + Eli each read the PR context
|
|
240
|
+
```
|
|
241
|
+
|
|
242
|
+
---
|
|
243
|
+
|
|
244
|
+
### Intelligent Routing — fh ask
|
|
245
|
+
|
|
246
|
+
Not sure which agent to use? Describe the task:
|
|
247
|
+
|
|
248
|
+
```bash
|
|
249
|
+
fh ask "fix the login timeout bug"
|
|
250
|
+
fh ask "write integration tests for the payment service"
|
|
251
|
+
fh ask "design the new onboarding flow"
|
|
252
|
+
fh ask "review the auth module for security issues"
|
|
253
|
+
```
|
|
254
|
+
|
|
255
|
+
`fh ask` analyzes the task description using keyword matching and returns:
|
|
256
|
+
- **Which agent or party** to use
|
|
257
|
+
- **Confidence level** (high / medium / low)
|
|
258
|
+
- **Why** — which keywords triggered the recommendation
|
|
259
|
+
- **Exact command** to run — either `cd <worktree> && claude` for a single agent or `fh party run <set>` for a party
|
|
260
|
+
|
|
261
|
+
`fh run "<freetext>"` does the same when the argument isn't a URL:
|
|
262
|
+
|
|
263
|
+
```bash
|
|
264
|
+
fh run "refactor the database layer" # routes to best agent automatically
|
|
265
|
+
```
|
|
266
|
+
|
|
267
|
+
---
|
|
268
|
+
|
|
269
|
+
### Product Workflow
|
|
270
|
+
|
|
271
|
+
`fh product` manages the full PRD → Epic → Story pipeline.
|
|
272
|
+
|
|
273
|
+
```bash
|
|
274
|
+
# PRDs
|
|
275
|
+
fh product prd "User Authentication Redesign" # create PRD-N (auto-incremented)
|
|
276
|
+
fh product list # list all PRDs with status and date
|
|
277
|
+
fh product show PRD-1 # print full PRD content
|
|
278
|
+
|
|
279
|
+
# Pipeline view
|
|
280
|
+
fh product status # tree: PRDs → Epics → Stories with status
|
|
281
|
+
fh product roadmap # write ROADMAP.md to project root
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
**Typical flow:**
|
|
285
|
+
|
|
286
|
+
```bash
|
|
287
|
+
fh product prd "Onboarding Redesign"
|
|
288
|
+
fh epic create "Welcome Flow" --prd PRD-1 --goal "Users complete setup in < 5 min"
|
|
289
|
+
fh story create "As a new user I want to see a setup checklist" --epic EPC-1 --points 3
|
|
290
|
+
fh product status # see the full pipeline as a tree
|
|
291
|
+
fh product roadmap # generate ROADMAP.md
|
|
292
|
+
```
|
|
293
|
+
|
|
294
|
+
`fh epic create --prd PRD-N` links the epic to a PRD at creation time. Epics without a PRD link appear as orphans in `fh product status`.
|
|
295
|
+
|
|
296
|
+
---
|
|
297
|
+
|
|
219
298
|
## Party Mode — Parallel Agent Sessions
|
|
220
299
|
|
|
221
300
|
Party Mode runs specialized agent sets in parallel, each in an isolated git worktree. Use this for reviews, design sessions, or full-release audits.
|
|
@@ -340,3 +419,9 @@ Run `fh party cleanup` to remove all finished worktrees.
|
|
|
340
419
|
|
|
341
420
|
**`fh cost` shows no data**
|
|
342
421
|
Cost tracking reads `~/.claude/` — requires Claude Code to be installed and to have run at least one session.
|
|
422
|
+
|
|
423
|
+
**`fh github sync` creates duplicate stories**
|
|
424
|
+
This shouldn't happen — `fh github sync` checks for `GitHub: #N` in existing story files and skips them. If you see duplicates, check that the story file contains the `GitHub: #N` reference line.
|
|
425
|
+
|
|
426
|
+
**`fh github setup` says "Nicht konfiguriert"**
|
|
427
|
+
Run `fh github setup` to configure the token and repository.
|