Interactive browser viewer for OpenSpec directories
npm install openspec-viewerInteractive browser viewer for OpenSpec directories.
``bash`
npm install -g openspec-viewer
Requires Node.js >= 20.0.0
`bash`
openspec-viewer [path] [options]
`bash`
openspec-viewer # Current directory
openspec-viewer ./my-project # Specific directory
openspec-viewer --port 8080 # Custom port
openspec-viewer --no-open # Don't auto-open browser
| Option | Description |
|--------|-------------|
| -p, --port | Port to run server on (default: 3000) |--no-open
| | Don't open browser automatically |-V, --version
| | Display version |-h, --help
| | Display help |
- Live file watching with auto-refresh
- Markdown and HTML rendering
- Task progress tracking with checkbox parsing
- Search across all content
- Dark mode UI
- Folder-based tab grouping for change files
OpenSpec is a specification-driven development framework:
- project.md - Project conventionsspecs/
- - Current specificationschanges/
- - Change proposals with proposal.md, tasks.md, design.mdchanges/archive/
- - Completed changes with date prefix
Each change can contain:
| File/Folder | Description |
|-------------|-------------|
| proposal.md | Change proposal and rationale |tasks.md
| | Implementation checklist (supports - [ ] checkboxes) |design.md
| | Technical design documentation |specs/
| | Spec delta files showing ADDED/MODIFIED/REMOVED requirements |
|
MIT