claude-plan-viewer 1.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,105 @@
1
+ # Claude Plan Viewer
2
+
3
+ > Browse, search, and read your Claude Code plans in a clean web UI
4
+
5
+ [![npm version](https://img.shields.io/npm/v/claude-plan-viewer.svg)](https://www.npmjs.com/package/claude-plan-viewer)
6
+ [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
7
+ [![Bun](https://img.shields.io/badge/Bun-%23000000.svg?logo=bun&logoColor=white)](https://bun.sh)
8
+
9
+ ![screenshot](screenshot.png)
10
+
11
+ ## Features
12
+
13
+ - Browse and search all your Claude Code plans
14
+ - Sort by title, project, modified date, or size
15
+ - Full markdown rendering with syntax highlighting
16
+ - Keyboard navigation (arrow keys, Cmd+K for search)
17
+ - Dark theme UI
18
+
19
+ ## Installation
20
+
21
+ ### Using npx (recommended)
22
+
23
+ ```bash
24
+ npx claude-plan-viewer
25
+ ```
26
+
27
+ ### Using bunx
28
+
29
+ ```bash
30
+ bunx claude-plan-viewer
31
+ ```
32
+
33
+ ### Global installation
34
+
35
+ ```bash
36
+ # With npm
37
+ npm install -g claude-plan-viewer
38
+
39
+ # With bun
40
+ bun install -g claude-plan-viewer
41
+ ```
42
+
43
+ Then run:
44
+
45
+ ```bash
46
+ claude-plan-viewer
47
+ ```
48
+
49
+ ### Standalone Binary
50
+
51
+ Download a pre-built binary from the [releases page](https://github.com/HelgeSverre/claude-plan-viewer/releases) or build your own:
52
+
53
+ ```bash
54
+ bun run build
55
+ ./dist/plans-viewer
56
+ ```
57
+
58
+ The binary is fully self-contained (~57MB) and works offline.
59
+
60
+ ## Usage
61
+
62
+ ```bash
63
+ # Start on auto-assigned port
64
+ claude-plan-viewer
65
+
66
+ # Start on specific port
67
+ claude-plan-viewer --port 8080
68
+ ```
69
+
70
+ The server will automatically find an available port if the requested port is in use.
71
+
72
+ ## Development
73
+
74
+ ```bash
75
+ # Install dependencies
76
+ bun install
77
+
78
+ # Run in development mode with hot reload
79
+ bun run dev
80
+ ```
81
+
82
+ ## Building
83
+
84
+ Build standalone binaries for different platforms:
85
+
86
+ ```bash
87
+ bun run build # Current platform
88
+ bun run build:macos-arm64 # macOS Apple Silicon
89
+ bun run build:macos-x64 # macOS Intel
90
+ bun run build:linux-x64 # Linux x64
91
+ bun run build:linux-arm64 # Linux ARM64
92
+ bun run build:windows # Windows x64
93
+ bun run build:all # All platforms
94
+ ```
95
+
96
+ ## Requirements
97
+
98
+ - [Bun](https://bun.sh) runtime (for development/npx usage)
99
+ - Claude Code with plan files in `~/.claude/plans`
100
+
101
+ Standalone binaries have no external dependencies.
102
+
103
+ ## License
104
+
105
+ MIT