CLI Reference
Every command. Every flag. Every way to make your terminal do the thing.
Global Options
These options are available for all commands:
| Command | Description |
|---|---|
| --help, -h | Show help for command |
| --version, -v | Show CLI version |
| --verbose | Enable verbose output |
| --quiet, -q | Suppress non-essential output |
| --no-color | Disable colored output |
| --json | Output in JSON format |
Project Commands
lv create
Create a new Loaded Vibes project from scratch.
lv create <project-name> [options]
Options:
--stack <type> Stack type: fullstack, api, frontend, cli, library
--wizard Use interactive wizard
--template <name> Use a specific template
--skip-install Skip dependency installation
--git Initialize git repository (default: true)
Examples:
lv create my-app --stack fullstack
lv create my-api --stack api --template express
lv create my-lib --stack library --skip-installlv init
Initialize Loaded Vibes in an existing project.
lv init [options]
Options:
--stack <type> Stack type (auto-detected if not provided)
--force Overwrite existing configuration
--minimal Minimal setup without optional features
--migrate Migrate from a previous version
Examples:
lv init
lv init --stack fullstack --force
lv init --migrateDevCycle Commands
lv devcycle run
Execute one or more DevCycles.
lv devcycle run <cycle...> [options]
Options:
--feature <name> Feature context for the cycle
--dry-run Preview actions without executing
--skip-checkpoints Skip checkpoint creation
--continue Continue from last checkpoint
--wizard Interactive mode with confirmations
Cycles:
init, scaffold, config, verify, data, auth, test, validate,
features, debug, security, perf, observe, review, docs,
cicd, deploy, updates
Examples:
lv devcycle run scaffold
lv devcycle run scaffold --feature user-auth
lv devcycle run init scaffold test --dry-run
lv devcycle run deploy --wizardlv devcycle status
Show current DevCycle state and progress.
lv devcycle status [options]
Options:
--cycle <name> Show status for specific cycle
--history Include execution history
--json Output as JSON
Examples:
lv devcycle status
lv devcycle status --cycle scaffold --historylv devcycle checkpoints
Manage DevCycle checkpoints.
lv devcycle checkpoints [action] [options]
Actions:
list List all checkpoints (default)
show <id> Show checkpoint details
restore <id> Restore to a checkpoint
delete <id> Delete a checkpoint
prune Remove old checkpoints
Options:
--cycle <name> Filter by cycle
--before <date> Filter by date
--keep <n> Keep last N checkpoints (for prune)
Examples:
lv devcycle checkpoints
lv devcycle checkpoints show scaffold-design-2024-01-15
lv devcycle checkpoints restore scaffold-design-2024-01-15
lv devcycle checkpoints prune --keep 5Dashboard & Monitoring
lv dashboard
Launch the interactive terminal dashboard.
lv dashboard [options]
Options:
--watch Auto-refresh on file changes
--logs Show live execution logs
--minimal Minimal UI mode
Examples:
lv dashboard
lv dashboard --watch --logslv logs
View and search execution logs.
lv logs [options]
Options:
--cycle <name> Filter by cycle
--phase <name> Filter by phase
--level <level> Filter by level (info, warn, error)
--since <time> Logs since time (1h, 2d, etc.)
--follow, -f Follow log output
--format <fmt> Output format (text, json, table)
Examples:
lv logs --cycle scaffold --since 1h
lv logs --level error --follow
lv logs --format json > logs.jsonDiagnostics
lv doctor
Run diagnostic checks on your environment.
lv doctor [options]
Options:
--fix Attempt to fix issues automatically
--verbose Show detailed diagnostic info
--json Output as JSON
Checks:
- Node.js version
- npm/pnpm version
- Git configuration
- VS Code integration
- MCP server connectivity
- Framework integrity
Examples:
lv doctor
lv doctor --fix --verboseAutomated fixes
lv doctor --fix. This includes reinstalling MCP servers, resetting configurations, and fixing file permissions.Upgrade & Maintenance
lv upgrade
Upgrade framework components.
lv upgrade [options]
Options:
--strategy <type> Upgrade strategy: mirror, merge, sandbox
--check Check for updates without upgrading
--force Force upgrade without confirmation
--backup Create backup before upgrade (default: true)
Strategies:
mirror - Replace all framework files (clean slate)
merge - Merge updates preserving customizations
sandbox - Apply to copy for testing
Examples:
lv upgrade --check
lv upgrade --strategy merge
lv upgrade --strategy sandboxlv restore
Restore from backup or previous state.
lv restore [target] [options]
Targets:
backup Restore from latest backup
checkpoint <id> Restore to checkpoint
version <version> Restore to specific version
Options:
--list List available restore points
--dry-run Preview restore actions
Examples:
lv restore --list
lv restore backup
lv restore checkpoint scaffold-design-2024-01-15Configuration
lv config
Manage framework configuration.
lv config [action] [key] [value] [options]
Actions:
get <key> Get configuration value
set <key> <value> Set configuration value
list List all configuration
reset Reset to defaults
edit Open config in editor
Options:
--global Use global configuration
--json Output as JSON
Examples:
lv config list
lv config get features.ai.enabled
lv config set features.telemetry.anonymous true
lv config editArtifact Management
lv artifact
Create and manage framework artifacts.
lv artifact <action> <type> [name] [options]
Actions:
create Create new artifact
list List artifacts
validate Validate artifacts
sync Sync with templates
Types:
prompt Prompt file (.prompt.md)
instructions Instructions file (.instructions.md)
toolset Toolset file (.toolset.jsonc)
agent Agent definition
Options:
--extends <name> Extend existing artifact
--applyTo <glob> Set applyTo pattern (instructions)
--template <name> Use specific template
Examples:
lv artifact create prompt my-task
lv artifact create instructions my-domain --applyTo "**/domain/**"
lv artifact list --type prompt
lv artifact validateUtilities
lv hint
Get contextual help based on project state.
lv hint [topic] [options]
Topics:
(none) Auto-detect from current state
devcycle DevCycle suggestions
error Help with last error
next What to do next
Options:
--detailed Show detailed explanations
Examples:
lv hint
lv hint devcycle
lv hint error --detailedlv docs
Access documentation.
lv docs [topic] [options]
Options:
--open Open in browser
--search <query> Search documentation
Examples:
lv docs
lv docs devcycles --open
lv docs --search "EARS notation"lv telemetry
Manage telemetry settings.
lv telemetry <action>
Actions:
status Show current settings
enable Enable telemetry
disable Disable telemetry
reset Reset to defaults
Examples:
lv telemetry status
lv telemetry disableTool Integration
lv tools
Manage MCP tool servers.
lv tools <action> [options]
Actions:
list List available tools
status Show tool status
install <tool> Install a tool
uninstall <tool> Uninstall a tool
restart Restart all tools
Options:
--verbose Show detailed info
Examples:
lv tools list
lv tools status
lv tools install postgres
lv tools restartExit Codes
| Command | Description |
|---|---|
| 0 | Success |
| 1 | General error |
| 2 | Invalid arguments |
| 3 | Configuration error |
| 4 | DevCycle failure |
| 5 | Checkpoint required |
| 10 | User cancelled |
Environment Variables
# Core
LV_CONFIG_PATH # Custom config file path
LV_LOG_LEVEL # Log level (debug, info, warn, error)
LV_NO_COLOR # Disable colored output
LV_NO_TELEMETRY # Disable telemetry
# MCP Integration
GITHUB_TOKEN # GitHub API token
DATABASE_URL # Database connection string
# Development
LV_DEBUG # Enable debug mode
LV_TRACE # Enable trace loggingNext Steps
See the Configuration Reference for detailed configuration options, or explore Running DevCycles for practical examples.