@quantracode/vibecheck 0.0.2 → 0.2.2
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 +64 -0
- package/dist/index.js +1126 -21
- package/package.json +20 -17
package/README.md
CHANGED
|
@@ -63,6 +63,70 @@ vibecheck scan --emit-intent-map
|
|
|
63
63
|
|
|
64
64
|
# Explain a scan report
|
|
65
65
|
vibecheck explain ./scan.json
|
|
66
|
+
|
|
67
|
+
# Start the web viewer
|
|
68
|
+
vibecheck view
|
|
69
|
+
|
|
70
|
+
# Open viewer with specific artifact
|
|
71
|
+
vibecheck view -a ./scan.json
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
## View Command
|
|
75
|
+
|
|
76
|
+
The `view` command starts a local web viewer to explore scan results interactively.
|
|
77
|
+
|
|
78
|
+
```bash
|
|
79
|
+
# Start viewer (auto-detects artifacts in current directory)
|
|
80
|
+
vibecheck view
|
|
81
|
+
|
|
82
|
+
# Specify artifact file explicitly
|
|
83
|
+
vibecheck view -a ./vibecheck-scan.json
|
|
84
|
+
vibecheck view --artifact ./scan-results.json
|
|
85
|
+
|
|
86
|
+
# Use a different port
|
|
87
|
+
vibecheck view --port 8080
|
|
88
|
+
|
|
89
|
+
# Don't auto-open browser
|
|
90
|
+
vibecheck view --no-open
|
|
91
|
+
|
|
92
|
+
# Force update the viewer to latest version
|
|
93
|
+
vibecheck view --update
|
|
94
|
+
|
|
95
|
+
# Clear cached viewer files
|
|
96
|
+
vibecheck view --clear-cache
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
### View Command Options
|
|
100
|
+
|
|
101
|
+
| Option | Description | Default |
|
|
102
|
+
|--------|-------------|---------|
|
|
103
|
+
| `-p, --port <port>` | Port to run the viewer on | `3000` |
|
|
104
|
+
| `-a, --artifact <path>` | Path to artifact file to open | Auto-detected |
|
|
105
|
+
| `--no-open` | Don't automatically open the browser | Opens browser |
|
|
106
|
+
| `--update` | Force update the viewer to latest version | - |
|
|
107
|
+
| `--clear-cache` | Clear the cached viewer and exit | - |
|
|
108
|
+
|
|
109
|
+
### How It Works
|
|
110
|
+
|
|
111
|
+
1. **Auto-download**: The viewer is automatically downloaded from npm on first run and cached in `~/.vibecheck/viewer/`
|
|
112
|
+
2. **Auto-detect artifacts**: Looks for scan artifacts in common locations:
|
|
113
|
+
- `vibecheck-artifacts/artifact.json`
|
|
114
|
+
- `vibecheck-artifact.json`
|
|
115
|
+
- `.vibecheck/artifact.json`
|
|
116
|
+
- `scan-results.json`
|
|
117
|
+
3. **Auto-load**: When an artifact is detected, it's automatically loaded into the viewer
|
|
118
|
+
4. **Local-only**: The viewer runs entirely on your machine with no external connections
|
|
119
|
+
|
|
120
|
+
### Workflow Example
|
|
121
|
+
|
|
122
|
+
```bash
|
|
123
|
+
# 1. Run a scan
|
|
124
|
+
vibecheck scan --out vibecheck-artifacts/artifact.json
|
|
125
|
+
|
|
126
|
+
# 2. View results (artifact auto-detected)
|
|
127
|
+
vibecheck view
|
|
128
|
+
|
|
129
|
+
# Browser opens to http://localhost:3000 with results loaded
|
|
66
130
|
```
|
|
67
131
|
|
|
68
132
|
### Command Line Options
|