Command-line interface for vibe-agent-toolkit
npm install @vibe-agent-toolkit/cliCommand-line interface for the Vibe Agent Toolkit.
Install the umbrella package globally:
``bash`
npm install -g vibe-agent-toolkit
Or install CLI package directly in a project:
`bash`
npm install @vibe-agent-toolkit/cli
`bashShow version (with context)
vat --version
$3
`bash
Scan markdown resources
vat resources scan docs/Validate link integrity
vat resources validate docs/Show resources help
vat resources --help --verbose
`$3
Index and query markdown documents using vector search:
`bash
Index markdown files into RAG database
vat rag index docs/Search the database
vat rag query "authentication methods"View database statistics
vat rag statsClear database (rebuild required after)
vat rag clear
`Database Options:
- Default:
.rag-db in project root
- Custom: --db flag on any commandEmbedding Model:
- Uses transformers.js with
all-MiniLM-L6-v2 (local, fast, free)
- 384-dimensional embeddings
- No API key required$3
Diagnose vat setup and environment health.
Usage:
`bash
Check environment and configuration
vat doctorShow all checks (including passing ones)
vat doctor --verbose
`What it checks:
- Node.js version (>=20 required)
- Git installation and repository
- Configuration file exists and is valid
- VAT version (checks for updates)
- CLI build status (in VAT source tree only)
Exit codes:
-
0 - All checks passed
- 1 - One or more checks failedExample output:
`
𩺠vat doctorRunning diagnostic checks...
ā
Node.js version
v22.0.0 (meets requirement: >=20.0.0)
ā
Git installed
git version 2.43.0
ā
Git repository
Current directory is a git repository
ā
Configuration file
Found: vibe-agent-toolkit.config.yaml
ā
Configuration valid
Configuration is valid
ā
vat version
Current: 0.1.0 ā up to date
š Results: 6/6 checks passed
⨠All checks passed! Your vat setup looks healthy.
`Troubleshooting:
If checks fail, doctor provides specific suggestions:
`
ā Node.js version
v18.0.0 is too old. Node.js 20+ required.
š” Upgrade Node.js: https://nodejs.org/ or use nvm
`$3
Create
vibe-agent-toolkit.config.yaml at project root:`yaml
version: 1
resources:
include:
- "docs/*/.md"
- "agents/**/README.md"
exclude:
- "node_modules/**"
- "/test/fixtures/"
validation:
checkLinks: true
checkAnchors: true
allowExternal: true
`$3
Set
VAT_ROOT_DIR to run from source:`bash
export VAT_ROOT_DIR=/path/to/vibe-agent-toolkit
vat --version # Shows: 0.1.0-dev (/path/to/vibe-agent-toolkit)
`Documentation
- CLI Reference - Complete command documentation (markdown source)
- Run
vat --help --verbose for the same documentation at runtime
- Architecture - Package structureDevelopment
`bash
Build
bun run buildTest (do NOT use 'bun test' directly)
bun run test:unit
bun run test:integration
bun run test:systemPrepare binaries after build
bun run prepare-cli-bin
``MIT Ā© Jeff Dutton