prd-parser 0.3.0 → 0.3.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.
Files changed (2) hide show
  1. package/README.md +100 -1
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -117,6 +117,8 @@ task operations without context-switching to a GUI.
117
117
  prd-parser parse docs/prd.md
118
118
  ```
119
119
 
120
+ Full context mode is enabled by default - every generation stage has access to your original PRD, producing the most coherent results.
121
+
120
122
  That's it. Your PRD is now a structured beads project with **readable hierarchical IDs**:
121
123
 
122
124
  ```bash
@@ -230,6 +232,9 @@ Issues are linked with proper blocking relationships:
230
232
  ### Parse Options
231
233
 
232
234
  ```bash
235
+ # Basic parse (full context mode is on by default)
236
+ prd-parser parse ./prd.md
237
+
233
238
  # Control structure size
234
239
  prd-parser parse ./prd.md --epics 5 --tasks 8 --subtasks 4
235
240
 
@@ -244,7 +249,10 @@ prd-parser parse ./prd.md --dry-run
244
249
 
245
250
  # Save/resume from checkpoint (useful for large PRDs)
246
251
  prd-parser parse ./prd.md --save-json checkpoint.json
247
- prd-parser parse ./prd.md --from-json checkpoint.json
252
+ prd-parser parse --from-json checkpoint.json
253
+
254
+ # Disable full context mode (not recommended)
255
+ prd-parser parse ./prd.md --full-context=false
248
256
  ```
249
257
 
250
258
  ### Full Options
@@ -261,6 +269,7 @@ prd-parser parse ./prd.md --from-json checkpoint.json
261
269
  | `--multi-stage` | | false | Force multi-stage parsing |
262
270
  | `--single-shot` | | false | Force single-shot parsing |
263
271
  | `--smart-threshold` | | 300 | Line count for auto multi-stage (0 to disable) |
272
+ | `--full-context` | | **true** | Pass PRD to all stages (use `=false` to disable) |
264
273
  | `--validate` | | false | Run validation pass to check for gaps |
265
274
  | `--no-review` | | false | Disable automatic LLM review pass (review ON by default) |
266
275
  | `--interactive` | | false | Human-in-the-loop mode (review epics before task generation) |
@@ -281,6 +290,96 @@ prd-parser automatically chooses the best parsing strategy based on PRD size:
281
290
 
282
291
  Override with `--single-shot` or `--multi-stage` flags, or adjust threshold with `--smart-threshold`.
283
292
 
293
+ ### Full Context Mode (Default)
294
+
295
+ Full context mode is **enabled by default**. Every stage gets the original PRD as their "north star":
296
+
297
+ ```bash
298
+ prd-parser parse docs/prd.md # full context is on by default
299
+ ```
300
+
301
+ To disable (not recommended):
302
+ ```bash
303
+ prd-parser parse docs/prd.md --full-context=false
304
+ ```
305
+
306
+ **Why this matters:**
307
+
308
+ | Mode | Stage 1 (Epics) | Stage 2 (Tasks) | Stage 3 (Subtasks) |
309
+ |------|----------------|-----------------|-------------------|
310
+ | Default | Full PRD | Epic summary only | Task summary only |
311
+ | `--full-context` | Full PRD | Epic + **PRD** | Task + **PRD** |
312
+
313
+ With `--full-context`, each agent:
314
+ - Stays grounded in original requirements
315
+ - Doesn't invent features not in the PRD
316
+ - Doesn't miss requirements that ARE in the PRD
317
+ - Produces more focused, coherent output
318
+
319
+ **Results comparison** (same PRD):
320
+
321
+ | Metric | Default | Full Context |
322
+ |--------|---------|--------------|
323
+ | Epics | 11 | 8 |
324
+ | Tasks | 65 | 49 |
325
+ | Subtasks | 264 | 202 |
326
+
327
+ Fewer items with full context = less redundancy, more focused on actual requirements.
328
+
329
+ ### Common Flag Combinations
330
+
331
+ **Standard parse (full context on by default):**
332
+ ```bash
333
+ prd-parser parse docs/prd.md
334
+ ```
335
+ Every stage sees the PRD. Best for accuracy and coherence.
336
+
337
+ **Preview before committing:**
338
+ ```bash
339
+ prd-parser parse docs/prd.md --dry-run
340
+ ```
341
+ See what would be created without actually creating issues.
342
+
343
+ **Save checkpoint for manual review:**
344
+ ```bash
345
+ prd-parser parse docs/prd.md --save-json draft.json --dry-run
346
+ # Edit draft.json manually
347
+ prd-parser parse --from-json draft.json
348
+ ```
349
+
350
+ **Human-in-the-loop for large/complex PRDs:**
351
+ ```bash
352
+ prd-parser parse docs/prd.md --interactive
353
+ ```
354
+ Review and edit epics before task generation.
355
+
356
+ **Quick parse for small PRDs:**
357
+ ```bash
358
+ prd-parser parse docs/prd.md --single-shot
359
+ ```
360
+ Faster single LLM call. Works well for PRDs under 300 lines.
361
+
362
+ **Cost-optimized for large PRDs:**
363
+ ```bash
364
+ prd-parser parse docs/prd.md --subtask-model claude-sonnet-4-20250514
365
+ ```
366
+ Use Opus for epics/tasks, Sonnet for subtasks (cheaper, still good quality).
367
+
368
+ **Maximum validation:**
369
+ ```bash
370
+ prd-parser parse docs/prd.md --validate
371
+ ```
372
+ Full context + validation pass to catch gaps.
373
+
374
+ **Debug/iterate on structure:**
375
+ ```bash
376
+ prd-parser parse docs/prd.md --save-json iter1.json --dry-run
377
+ # Review iter1.json, note issues
378
+ prd-parser parse docs/prd.md --save-json iter2.json --dry-run
379
+ # Compare, pick the better one
380
+ prd-parser parse --from-json iter2.json
381
+ ```
382
+
284
383
  ### Validation Pass
285
384
 
286
385
  Use `--validate` to run a final review that checks for gaps in the generated plan:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "prd-parser",
3
- "version": "0.3.0",
3
+ "version": "0.3.1",
4
4
  "description": "Turn your PRD into a ready-to-work beads project in one command",
5
5
  "keywords": [
6
6
  "prd",