verus-pm 0.1.0 → 0.2.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 +190 -47
- package/bin/verus +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -21,7 +21,7 @@ All in one command — CLI + Web Dashboard included.
|
|
|
21
21
|
npm install -g verus
|
|
22
22
|
```
|
|
23
23
|
|
|
24
|
-
That's it. CLI + Web Dashboard + MCP Server — all in one
|
|
24
|
+
That's it. CLI + Web Dashboard + MCP Server — all in one *high-performance native Go binary* shipped via npm.
|
|
25
25
|
|
|
26
26
|
### Verify
|
|
27
27
|
|
|
@@ -61,76 +61,156 @@ verus browser
|
|
|
61
61
|
| 🔄 Imports | `verus import add` | Manage sources |
|
|
62
62
|
| 🛠️ Skills | `verus skill install` | — |
|
|
63
63
|
| 🔐 Offline Search | `verus model download` | — |
|
|
64
|
+
| 🔄 Update | `verus update` | — |
|
|
64
65
|
|
|
65
66
|
---
|
|
66
67
|
|
|
67
68
|
## 📋 CLI Reference
|
|
68
69
|
|
|
70
|
+
### Project Setup
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
verus init # Interactive project setup
|
|
74
|
+
verus init my-project # Init with name
|
|
75
|
+
verus init --no-wizard # Non-interactive (use defaults)
|
|
76
|
+
verus init --force # Reinitialize existing project
|
|
77
|
+
verus update # Update skills, rules, .mcp.json (keeps tasks/docs)
|
|
78
|
+
verus update --no-skills # Skip skill update
|
|
79
|
+
verus update --no-rules # Skip agent guideline update
|
|
80
|
+
verus update --no-mcp # Skip .mcp.json update
|
|
81
|
+
verus update --no-config # Skip config/flow update
|
|
82
|
+
verus validate # Validate project integrity
|
|
83
|
+
```
|
|
84
|
+
|
|
69
85
|
### Tasks
|
|
70
86
|
|
|
71
87
|
```bash
|
|
72
|
-
verus task list # List all
|
|
73
|
-
verus task list --status in-progress # Filter
|
|
74
|
-
verus task
|
|
75
|
-
verus task
|
|
76
|
-
verus task
|
|
77
|
-
verus task
|
|
78
|
-
verus task
|
|
88
|
+
verus task list # List all tasks
|
|
89
|
+
verus task list --status in-progress # Filter by status
|
|
90
|
+
verus task list --priority high # Filter by priority
|
|
91
|
+
verus task list --assignee "@me" # Filter by assignee
|
|
92
|
+
verus task create "Fix login bug" -p high # Create with priority
|
|
93
|
+
verus task create "Auth" --labels "be,auth" # Create with labels
|
|
94
|
+
verus task view abc123 # View task detail
|
|
95
|
+
verus task edit abc123 --status done # Update status
|
|
96
|
+
verus task edit abc123 --priority high # Update priority
|
|
97
|
+
verus task edit abc123 --ac "Tests pass" # Add acceptance criteria
|
|
98
|
+
verus task delete abc123 # Delete task
|
|
79
99
|
```
|
|
80
100
|
|
|
81
|
-
###
|
|
101
|
+
### Documentation
|
|
82
102
|
|
|
83
103
|
```bash
|
|
84
|
-
verus doc list # List all
|
|
85
|
-
verus doc create "API Design"
|
|
86
|
-
verus doc
|
|
104
|
+
verus doc list # List all docs
|
|
105
|
+
verus doc create "API Design" # Create doc
|
|
106
|
+
verus doc create "Auth Spec" --folder specs # Create in folder
|
|
107
|
+
verus doc view specs/auth-spec # View doc content
|
|
87
108
|
```
|
|
88
109
|
|
|
89
110
|
### Time Tracking
|
|
90
111
|
|
|
91
112
|
```bash
|
|
92
|
-
verus time start abc123 # Start timer
|
|
93
|
-
verus time stop abc123 # Stop & record
|
|
94
|
-
verus time status #
|
|
95
|
-
verus time add abc123 2h30m # Add manually
|
|
96
|
-
verus time report #
|
|
113
|
+
verus time start abc123 # Start timer for task
|
|
114
|
+
verus time stop abc123 # Stop timer & record
|
|
115
|
+
verus time status # Show active timers
|
|
116
|
+
verus time add abc123 2h30m # Add time manually
|
|
117
|
+
verus time report # Time report (by task)
|
|
118
|
+
verus time report --group label # Report grouped by label
|
|
119
|
+
verus time report --group status # Report grouped by status
|
|
97
120
|
```
|
|
98
121
|
|
|
99
|
-
### Board
|
|
122
|
+
### Board & Search
|
|
100
123
|
|
|
101
124
|
```bash
|
|
102
|
-
verus board # Kanban in terminal
|
|
103
|
-
verus search "authentication" # Full-text search
|
|
104
|
-
verus
|
|
125
|
+
verus board # Kanban board in terminal
|
|
126
|
+
verus search "authentication" # Full-text search (tasks + docs)
|
|
127
|
+
verus search "bug" --type task # Search tasks only
|
|
128
|
+
verus search "api" --type doc # Search docs only
|
|
129
|
+
verus search "auth" --limit 5 # Limit results
|
|
130
|
+
verus search --reindex # Rebuild search index
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
### Configuration
|
|
134
|
+
|
|
135
|
+
```bash
|
|
136
|
+
verus config get # Show all config
|
|
137
|
+
verus config get name # Get specific value
|
|
105
138
|
verus config set name "My App" # Set value
|
|
106
139
|
```
|
|
107
140
|
|
|
108
|
-
### Models
|
|
141
|
+
### Models (Semantic Search)
|
|
142
|
+
|
|
143
|
+
```bash
|
|
144
|
+
verus model list # List available embedding models
|
|
145
|
+
verus model download gte-small # Download a model
|
|
146
|
+
verus model path # Show model storage directory
|
|
147
|
+
verus model remove gte-small # Remove a downloaded model
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
### Templates
|
|
151
|
+
|
|
152
|
+
```bash
|
|
153
|
+
verus template list # List available templates
|
|
154
|
+
verus template run component # Run template (generates code)
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
### Imports
|
|
158
|
+
|
|
159
|
+
```bash
|
|
160
|
+
verus import add <git-url> # Import from git repo
|
|
161
|
+
verus import add <npm-package> # Import from npm
|
|
162
|
+
verus import list # List imported sources
|
|
163
|
+
verus import sync # Sync all imports (pull latest)
|
|
164
|
+
verus import remove <name> # Remove an import
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
### Skills
|
|
168
|
+
|
|
169
|
+
```bash
|
|
170
|
+
verus skill list # List all skills (project + built-in)
|
|
171
|
+
verus skill install # Install all built-in skills
|
|
172
|
+
verus skill install <name> # Install specific skill
|
|
173
|
+
verus skill sync # Sync skills to AI platforms
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
### Sync (Agent Integration)
|
|
177
|
+
|
|
178
|
+
```bash
|
|
179
|
+
verus sync agents # Update AGENTS.md, GEMINI.md, CLAUDE.md
|
|
180
|
+
verus sync agents --platform claude # Sync for specific platform
|
|
181
|
+
verus sync mcp # Setup MCP in .mcp.json + Claude Code
|
|
182
|
+
verus sync mcp --project # Only create .mcp.json
|
|
183
|
+
verus sync mcp --global # Only setup Claude Code CLI
|
|
184
|
+
verus sync skills # Sync skills from .agent/skills/ to .verus/skills/
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
### Server & Web UI
|
|
109
188
|
|
|
110
189
|
```bash
|
|
111
|
-
verus
|
|
112
|
-
verus
|
|
113
|
-
verus
|
|
114
|
-
verus
|
|
115
|
-
verus
|
|
116
|
-
verus import sync # Sync all
|
|
190
|
+
verus serve # Start API server (port 3456)
|
|
191
|
+
verus serve -p 8080 # Start on custom port
|
|
192
|
+
verus browser # Open Web UI (starts server if needed)
|
|
193
|
+
verus browser --no-open # Start server without opening browser
|
|
194
|
+
verus browser -p 8080 # Use custom port
|
|
117
195
|
```
|
|
118
196
|
|
|
119
|
-
###
|
|
197
|
+
### MCP Server
|
|
120
198
|
|
|
121
199
|
```bash
|
|
122
|
-
verus
|
|
123
|
-
verus
|
|
124
|
-
verus
|
|
125
|
-
verus sync mcp # Generate .mcp.json
|
|
200
|
+
verus mcp # Start MCP server (stdio transport)
|
|
201
|
+
verus mcp --port 3457 # Start MCP server (HTTP SSE transport)
|
|
202
|
+
verus mcp --root /path/to/proj # Explicitly set project root
|
|
126
203
|
```
|
|
127
204
|
|
|
128
|
-
###
|
|
205
|
+
### Utilities
|
|
129
206
|
|
|
130
207
|
```bash
|
|
131
|
-
verus
|
|
132
|
-
verus
|
|
133
|
-
verus
|
|
208
|
+
verus version # Show version
|
|
209
|
+
verus guidelines # Show AI agent guidelines
|
|
210
|
+
verus guidelines --plain # Plain text output
|
|
211
|
+
verus completion bash # Generate shell completions
|
|
212
|
+
verus completion zsh
|
|
213
|
+
verus completion fish
|
|
134
214
|
```
|
|
135
215
|
|
|
136
216
|
---
|
|
@@ -147,11 +227,11 @@ Included in the npm package — no separate install needed.
|
|
|
147
227
|
|
|
148
228
|
## 🤖 MCP Integration
|
|
149
229
|
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
230
|
+
Verus provides an MCP (Model Context Protocol) server for AI agent integration, allowing tools like Claude Code, Antigravity, Cursor, and others to create/manage tasks, docs, and more.
|
|
231
|
+
|
|
232
|
+
### Stdio Transport (Default)
|
|
153
233
|
|
|
154
|
-
|
|
234
|
+
The most common way to connect — `verus init` auto-generates `.mcp.json`:
|
|
155
235
|
|
|
156
236
|
```json
|
|
157
237
|
{
|
|
@@ -161,6 +241,48 @@ Or manually add to `.mcp.json`:
|
|
|
161
241
|
}
|
|
162
242
|
```
|
|
163
243
|
|
|
244
|
+
The MCP server auto-detects the project from the working directory set by your IDE.
|
|
245
|
+
|
|
246
|
+
### HTTP SSE Transport
|
|
247
|
+
|
|
248
|
+
For multi-process setups or debugging:
|
|
249
|
+
|
|
250
|
+
```bash
|
|
251
|
+
verus mcp --port 3457
|
|
252
|
+
```
|
|
253
|
+
|
|
254
|
+
Then configure your MCP client to connect via SSE to `http://localhost:3457/sse`.
|
|
255
|
+
|
|
256
|
+
### Available MCP Tools
|
|
257
|
+
|
|
258
|
+
| Tool | Description |
|
|
259
|
+
|------|-------------|
|
|
260
|
+
| `create_task` | Create a new task |
|
|
261
|
+
| `list_tasks` | List tasks with filters |
|
|
262
|
+
| `get_task` | Get task by ID |
|
|
263
|
+
| `update_task` | Update task fields |
|
|
264
|
+
| `delete_task` | Delete a task |
|
|
265
|
+
| `get_board` | Get task board by status |
|
|
266
|
+
| `create_doc` | Create documentation |
|
|
267
|
+
| `list_docs` | List all docs |
|
|
268
|
+
| `get_doc` | Get doc by path |
|
|
269
|
+
| `update_doc` | Update doc content/metadata |
|
|
270
|
+
| `search` | Search tasks and docs |
|
|
271
|
+
| `list_templates` | List code templates |
|
|
272
|
+
| `get_template` | Get template config |
|
|
273
|
+
| `run_template` | Run code generation |
|
|
274
|
+
| `create_template` | Create template scaffold |
|
|
275
|
+
| `start_time` | Start task timer |
|
|
276
|
+
| `stop_time` | Stop task timer |
|
|
277
|
+
| `time_status` | Active timers |
|
|
278
|
+
| `add_time` | Add time entry |
|
|
279
|
+
| `get_time_report` | Time report |
|
|
280
|
+
| `get_config` | Get project config |
|
|
281
|
+
| `set_config` | Set config value |
|
|
282
|
+
| `validate` | Validate project integrity |
|
|
283
|
+
|
|
284
|
+
> **Note**: `verus browser` runs the Web UI independently of the MCP service. Web UI logs never interrupt the `stdio` JSON-RPC connection.
|
|
285
|
+
|
|
164
286
|
---
|
|
165
287
|
|
|
166
288
|
## 🔧 Development (Local)
|
|
@@ -180,7 +302,7 @@ cd verus
|
|
|
180
302
|
make npm-local
|
|
181
303
|
```
|
|
182
304
|
|
|
183
|
-
|
|
305
|
+
Verify:
|
|
184
306
|
|
|
185
307
|
```bash
|
|
186
308
|
verus version
|
|
@@ -201,6 +323,16 @@ make dev-ui
|
|
|
201
323
|
|
|
202
324
|
No need to `npm link` again — changes are live immediately.
|
|
203
325
|
|
|
326
|
+
### Full Rebuild
|
|
327
|
+
|
|
328
|
+
After pulling changes or major updates:
|
|
329
|
+
|
|
330
|
+
```bash
|
|
331
|
+
make rebuild
|
|
332
|
+
```
|
|
333
|
+
|
|
334
|
+
This kills old processes, cleans artifacts, rebuilds UI + Go binary, and re-links npm globally.
|
|
335
|
+
|
|
204
336
|
### Live Dev Mode (Hot Reload)
|
|
205
337
|
|
|
206
338
|
For frontend development with Vite HMR:
|
|
@@ -215,10 +347,12 @@ make dev
|
|
|
215
347
|
|
|
216
348
|
```
|
|
217
349
|
make npm-local # First time: build all + npm link
|
|
350
|
+
make rebuild # Full rebuild: clean + build all + npm link
|
|
218
351
|
make dev-go # Rebuild Go binary only (~1s)
|
|
219
352
|
make dev-ui # Rebuild UI only (~7s)
|
|
220
353
|
make dev # Live dev servers (Go + Vite HMR)
|
|
221
354
|
make npm-package # Build for npm publishing
|
|
355
|
+
make release # Build release binaries (cross-platform)
|
|
222
356
|
make clean # Remove build artifacts
|
|
223
357
|
make help # Show all targets
|
|
224
358
|
```
|
|
@@ -229,11 +363,20 @@ make help # Show all targets
|
|
|
229
363
|
|
|
230
364
|
```
|
|
231
365
|
.verus/ # Created by `verus init`
|
|
232
|
-
├── config.
|
|
233
|
-
├──
|
|
234
|
-
├──
|
|
235
|
-
├──
|
|
236
|
-
|
|
366
|
+
├── config.json # Project config (internal)
|
|
367
|
+
├── config.yaml # Project settings
|
|
368
|
+
├── flow.yaml # Workflow & status definitions
|
|
369
|
+
├── tasks/ # Task files (markdown + frontmatter)
|
|
370
|
+
├── docs/ # Documentation (markdown)
|
|
371
|
+
├── templates/ # Code generation templates
|
|
372
|
+
├── skills/ # AI skills (SKILL.md files)
|
|
373
|
+
└── search-index/ # FTS5 search index (auto-generated)
|
|
374
|
+
|
|
375
|
+
.mcp.json # MCP server config (auto-generated by init)
|
|
376
|
+
AGENTS.md # Agent guidelines (generic)
|
|
377
|
+
GEMINI.md # Antigravity/Gemini rules
|
|
378
|
+
CLAUDE.md # Claude Code rules
|
|
379
|
+
.cursorrules # Cursor rules
|
|
237
380
|
```
|
|
238
381
|
|
|
239
382
|
---
|
package/bin/verus
CHANGED
|
Binary file
|