plan-review 0.1.0 → 0.1.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 +65 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# plan-review
|
|
2
|
+
|
|
3
|
+
Interactive CLI for reviewing AI-generated markdown plans. Parses plans into sections, renders them in the terminal, collects your comments, and outputs structured feedback.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g plan-review
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
plan-review path/to/plan.md
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
### Options
|
|
18
|
+
|
|
19
|
+
```
|
|
20
|
+
-o, --output <target> Output target: stdout, clipboard, file, claude
|
|
21
|
+
--output-file <path> Custom output file path (with --output file)
|
|
22
|
+
--split-by <strategy> Force split strategy: heading, separator
|
|
23
|
+
-V, --version Show version
|
|
24
|
+
-h, --help Show help
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
If `-o` is omitted, you'll be prompted to choose after the review.
|
|
28
|
+
|
|
29
|
+
### Interactive commands
|
|
30
|
+
|
|
31
|
+
| Command | Action |
|
|
32
|
+
|---------|--------|
|
|
33
|
+
| `all` | Linear review through all sections |
|
|
34
|
+
| `1.1` | Jump to a specific section |
|
|
35
|
+
| `done` / `q` | Finish review |
|
|
36
|
+
| `toc` | Return to table of contents |
|
|
37
|
+
| `back` | Go to previous section |
|
|
38
|
+
| *(enter)* | Skip section |
|
|
39
|
+
| *(any text)* | Add comment on current section |
|
|
40
|
+
|
|
41
|
+
## How it works
|
|
42
|
+
|
|
43
|
+
1. **Parses** your markdown — auto-detects plan-style documents (milestones, tasks, dependencies) or falls back to generic heading-based splitting
|
|
44
|
+
2. **Renders** a table of contents with section navigation
|
|
45
|
+
3. **Collects** your comments as you review each section
|
|
46
|
+
4. **Outputs** structured markdown with your comments alongside the original content
|
|
47
|
+
|
|
48
|
+
### Plan mode
|
|
49
|
+
|
|
50
|
+
Documents with `## Milestone` / `### Task` hierarchy and fields like `**Depends On:**`, `**Blocks:**`, `**Verification:**` are detected as plans. Sections show dependency metadata and task IDs.
|
|
51
|
+
|
|
52
|
+
### Generic mode
|
|
53
|
+
|
|
54
|
+
Any markdown with headings gets split into reviewable sections.
|
|
55
|
+
|
|
56
|
+
## Output targets
|
|
57
|
+
|
|
58
|
+
- **stdout** — print to terminal (default)
|
|
59
|
+
- **clipboard** — copy to clipboard (pbcopy/xclip)
|
|
60
|
+
- **file** — write to `<input>.review.md` or custom path
|
|
61
|
+
- **claude** — pipe directly to Claude Code CLI
|
|
62
|
+
|
|
63
|
+
## License
|
|
64
|
+
|
|
65
|
+
MIT
|