@quantracode/vibecheck-viewer
v0.0.9
Published
Web viewer for VibeCheck security scan results
Maintainers
Readme
@quantracode/vibecheck-viewer
Static web viewer for VibeCheck security scan results.
This package contains the pre-built static export of the VibeCheck web UI. It is automatically downloaded and served by the vibecheck view command.
Usage
This package is not intended to be used directly. Instead, use the CLI:
# Start the viewer (auto-detects artifacts)
npx @quantracode/vibecheck view
# Or if installed globally
vibecheck view
# Specify an artifact file
vibecheck view -a ./scan-results.json
# Use a different port
vibecheck view --port 8080
# Don't open browser automatically
vibecheck view --no-openWhat's Included
- Static HTML/JS/CSS for the VibeCheck web viewer
- Client-side only - no server required
- Works offline after initial page load
- IndexedDB storage for imported artifacts
- Dark/light theme support
Features
- Dashboard: Overview with severity breakdown, security score, and "What to Fix First" priority list
- Findings List: Searchable, filterable list with batch operations (select, export, waive)
- Finding Details: Deep dive into individual findings with code evidence and AI-native enhancements
- Architecture View: Visual graph of routes, middleware, and intent claims
- Report Export: Export to Markdown, JSON, or CSV formats
AI-Native Developer Features
The viewer includes special features for developers who build with AI assistants:
- Plain English Explanations: Findings display "What's wrong" and "Why it matters" in simple terms
- Step-by-Step Fix Wizard: Interactive guide through remediation with code examples
- Code Comparison: Side-by-side before/after code snippets
- Copy to AI Button: One-click copy of AI prompts for Claude, ChatGPT, or other assistants
- View Mode Toggle: Switch between Simple/Technical/Full detail levels
- Smart Waivers: Educational flow when waiving findings, ensuring developers understand the risk
- AI Chat Dialog: Ask questions about findings (local simulation with pattern-based responses)
How Auto-Loading Works
When running vibecheck view, the CLI:
- Starts a local HTTP server serving the viewer
- Exposes the artifact at a special endpoint (
/__vibecheck__/artifact.json) - The viewer checks this endpoint on load and auto-imports the artifact
This means you can run vibecheck scan && vibecheck view and see results immediately.
Building from Source
# From the monorepo root
pnpm --filter @quantracode/vibecheck-viewer buildThis builds the Next.js web app and copies the static export to this package's dist directory.
Cache Location
The viewer is cached at:
- Linux/macOS:
~/.vibecheck/viewer/ - Windows:
%USERPROFILE%\.vibecheck\viewer\
To clear the cache:
vibecheck view --clear-cacheTo force an update:
vibecheck view --update