CLI Reference
Complete reference for all SystemPrompt CLI commands
On this page
Complete reference for the SystemPrompt command-line interface.
Command Structure
systemprompt <domain> <subcommand> [args] [flags]
Global Flags
| Flag | Short | Description |
|---|---|---|
--verbose |
-v |
Increase output verbosity |
--quiet |
-q |
Suppress non-essential output |
--profile |
-p |
Use specific profile |
--json |
Output as JSON | |
--help |
-h |
Show help |
--version |
-V |
Show version |
core
Content, playbooks, skills, and files management.
core playbooks
# List all playbooks
systemprompt core playbooks list
# Show playbook content
systemprompt core playbooks show <playbook_id>
# Show raw markdown (for piping)
systemprompt core playbooks show <playbook_id> --raw
# Sync playbooks from files
systemprompt core playbooks sync --direction to-db -y
core content
# List content
systemprompt core content list [--source <source>] [--limit <n>]
# Show content by ID
systemprompt core content show <content_id>
# Search content
systemprompt core content search <query> [--source <source>]
# Create content
systemprompt core content create --source <source> --file <path>
# Delete content
systemprompt core content delete <content_id>
core files
# List files
systemprompt core files list [--path <path>]
# Upload file
systemprompt core files upload <local_path> [--path <remote_path>]
# Download file
systemprompt core files download <file_id> [--output <path>]
# Delete file
systemprompt core files delete <file_id>
core skills
# List skills
systemprompt core skills list
# Show skill details
systemprompt core skills show <skill_id>
# Sync skills
systemprompt core skills sync --direction to-db -y
infra
Infrastructure and service management.
infra services
# Start all services
systemprompt infra services start --all
# Start specific service
systemprompt infra services start <service>
# Stop services
systemprompt infra services stop --all
systemprompt infra services stop <service>
# Check status
systemprompt infra services status
# Restart service
systemprompt infra services restart <service>
infra db
# Run migrations
systemprompt infra db migrate
# Check migration status
systemprompt infra db status
# Execute SQL query
systemprompt infra db query "<sql>"
# Backup database
systemprompt infra db backup --output <file>
# Restore database
systemprompt infra db restore --input <file>
infra jobs
# List scheduled jobs
systemprompt infra jobs list
# Run job manually
systemprompt infra jobs run <job_id>
# View job history
systemprompt infra jobs history [--job <job_id>] [--limit <n>]
# View job logs
systemprompt infra jobs logs <job_id> [--lines <n>]
# Enable/disable job
systemprompt infra jobs enable <job_id>
systemprompt infra jobs disable <job_id>
infra logs
# View logs
systemprompt infra logs [--service <service>] [--lines <n>]
# Follow logs
systemprompt infra logs --follow
# Filter by level
systemprompt infra logs --level error
admin
Administrative operations.
admin agents
# List agents
systemprompt admin agents list
# Show agent details
systemprompt admin agents show <agent_name>
# Send message to agent
systemprompt admin agents message <agent_name> "<message>"
# View agent tools
systemprompt admin agents tools <agent_name>
# Restart agent
systemprompt admin agents restart <agent_name>
# View agent logs
systemprompt admin agents logs <agent_name> [--lines <n>]
admin users
# List users
systemprompt admin users list [--limit <n>]
# Show user
systemprompt admin users show <user_id>
# Create user
systemprompt admin users create --email <email> [--name <name>]
# Delete user
systemprompt admin users delete <user_id>
# Update user role
systemprompt admin users role <user_id> <role>
admin config
# Show current config
systemprompt admin config show
# Validate config
systemprompt admin config validate
# Set secret
systemprompt admin config set-secret <key> <value>
# Get secret
systemprompt admin config get-secret <key>
# List secrets
systemprompt admin config list-secrets
admin session
# Show current session
systemprompt admin session show
# Clear session
systemprompt admin session clear
cloud
Cloud deployment and synchronization.
cloud auth
# Login to cloud
systemprompt cloud auth login
# Logout
systemprompt cloud auth logout
# Check auth status
systemprompt cloud auth status
# Refresh token
systemprompt cloud auth refresh
cloud tenant
# Create local tenant
systemprompt cloud tenant create --type local
# Create cloud tenant
systemprompt cloud tenant create --region <region>
# List tenants
systemprompt cloud tenant list
# Show tenant details
systemprompt cloud tenant show [--id <tenant_id>]
# Delete tenant
systemprompt cloud tenant delete <tenant_id>
cloud profile
# Create profile
systemprompt cloud profile create <name>
# List profiles
systemprompt cloud profile list
# Show current profile
systemprompt cloud profile show
# Switch profile
systemprompt cloud profile use <name>
# Delete profile
systemprompt cloud profile delete <name>
# Edit profile
systemprompt cloud profile edit <name>
cloud sync
# Sync content to database
systemprompt cloud sync local content --direction to-db -y
# Sync content to disk
systemprompt cloud sync local content --direction to-disk -y
# Sync specific source
systemprompt cloud sync local content --direction to-db --source blog -y
# Sync agents
systemprompt cloud sync local agents --direction to-db -y
# Sync MCP servers
systemprompt cloud sync local mcp --direction to-db -y
# Sync all
systemprompt cloud sync local --all --direction to-db -y
cloud deploy
# Deploy to cloud
systemprompt cloud deploy --profile <profile>
# Deploy with verbose output
systemprompt cloud deploy --profile <profile> -v
# Deploy specific services
systemprompt cloud deploy --profile <profile> --services api,scheduler
analytics
Metrics and reporting.
# View dashboard
systemprompt analytics dashboard
# Export metrics
systemprompt analytics export --from <date> --to <date> --output <file>
# View specific metric
systemprompt analytics metric <metric_name> [--period <period>]
plugins
MCP server management.
# List MCP servers
systemprompt plugins mcp list
# Show MCP server
systemprompt plugins mcp show <server_name>
# Test MCP server
systemprompt plugins mcp test <server_name>
# View MCP tools
systemprompt plugins mcp tools <server_name>
build
Build utilities.
# Build MCP servers
systemprompt build mcp [--release]
# Build all
systemprompt build all [--release]
Exit Codes
| Code | Meaning |
|---|---|
| 0 | Success |
| 1 | General error |
| 2 | Invalid arguments |
| 3 | Configuration error |
| 4 | Network error |
| 5 | Authentication error |
| 6 | Permission denied |
| 7 | Resource not found |