acp-visualizer-tui 0.1.0

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 ADDED
@@ -0,0 +1,82 @@
1
+ # acp-visualizer-tui
2
+
3
+ Terminal-based interactive visualizer for ACP progress.yaml data.
4
+
5
+ > Built with [Agent Context Protocol](https://github.com/prmichaelsen/agent-context-protocol)
6
+
7
+ ## Quick Start
8
+
9
+ ```bash
10
+ npx acp-visualizer-tui
11
+ ```
12
+
13
+ Or with a specific path:
14
+
15
+ ```bash
16
+ npx acp-visualizer-tui ./path/to/progress.yaml
17
+ ```
18
+
19
+ ## Usage
20
+
21
+ ```
22
+ $ acp-visualizer-tui [path] [options]
23
+
24
+ Arguments:
25
+ path Path to progress.yaml (default: ./agent/progress.yaml)
26
+
27
+ Options:
28
+ -w, --watch Watch mode: auto-refresh on file changes
29
+ -v, --view Initial view: dashboard|milestones|tasks|activity|blockers
30
+ --json Output parsed data as JSON (non-interactive)
31
+ --no-color Disable colors (for piping)
32
+ -h, --help Show help
33
+ -V, --version Show version
34
+ ```
35
+
36
+ ## Keyboard Shortcuts
37
+
38
+ | Key | Action |
39
+ |-----|--------|
40
+ | `Tab` / `Shift+Tab` | Switch between views |
41
+ | `j` / `k` or `↑` / `↓` | Navigate within list/table |
42
+ | `Enter` / `Space` | Expand/collapse tree node |
43
+ | `s` | Cycle sort column (milestone table) |
44
+ | `f` | Cycle status filter (All → In Progress → Completed → Not Started) |
45
+ | `r` | Manual refresh |
46
+ | `q` | Quit |
47
+ | `?` | Show help |
48
+
49
+ ## Views
50
+
51
+ - **Dashboard** — Project overview with progress bars, milestone summary, next steps
52
+ - **Milestones** — Sortable table with status badges, progress %, task counts
53
+ - **Tasks** — Expandable tree: milestones → tasks with status indicators
54
+ - **Activity** — Recent work timeline with dates and bullet items
55
+ - **Blockers** — Current blockers and next steps
56
+
57
+ ## Features
58
+
59
+ - Interactive full-screen TUI with keyboard navigation
60
+ - Watch mode (`-w`) auto-refreshes when progress.yaml changes
61
+ - Status filtering across all views
62
+ - `--json` for machine-readable output (great for scripting)
63
+ - `--no-color` for piping to files
64
+ - Rich 256-color support with graceful 16-color fallback
65
+
66
+ ## Development
67
+
68
+ ```bash
69
+ npm install
70
+ npm run build # Build CLI to dist/
71
+ npm run dev # Build with watch
72
+ npm run test # Run tests
73
+ npm run typecheck # TypeScript check
74
+ ```
75
+
76
+ ## License
77
+
78
+ MIT
79
+
80
+ ## Author
81
+
82
+ Patrick Michaelsen