CLI Reference

CLI Reference

OpenSoul provides a comprehensive CLI for managing the gateway, channels, and agent interactions.

Core Commands

Command	Description
opensoul onboard	Run the interactive onboarding wizard
opensoul gateway	Start the gateway (foreground)
opensoul gateway run	Start the gateway (production mode)
opensoul gateway status	Check gateway status
opensoul health	Health check
opensoul doctor	Diagnose configuration issues
opensoul doctor --fix	Auto-fix configuration issues

Channel Commands

Command	Description
opensoul channels login	Login to channels (WhatsApp QR, etc.)
opensoul channels status	View channel connection status
opensoul pairing list <channel>	List pending pairing requests
opensoul pairing approve <channel> <code>	Approve a pairing request

Device Commands

Command	Description
opensoul devices list	List connected/pending devices
opensoul devices approve <id>	Approve a device
opensoul devices revoke --device <id> --role <role>	Revoke device access

Configuration Commands

Command	Description
opensoul configure	Interactive configuration
opensoul configure --section <name>	Configure a specific section
opensoul config get	View current configuration
opensoul config set <key> <value>	Set a config value

Message Commands

Command	Description
opensoul message send --target <id> --message <text>	Send a test message
opensoul dashboard	Open the Control UI in browser

Gateway RPC

Call Gateway methods directly:

opensoul gateway call <method> --params '<json>'

Common RPC methods:

• config.get / config.apply / config.patch
• status / health
• sessions.list / sessions.patch
• cron.list / cron.add / cron.run
• skills.list / skills.enable / skills.disable

Development Commands

Command	Description
pnpm install	Install dependencies
pnpm build	Build the project
pnpm dev	Development mode with watch
pnpm gateway:dev	Gateway development mode
pnpm check	Type-check + lint + format-check
pnpm test	Run all tests
pnpm ui:build	Build the Control UI

Windows Development (PowerShell)

$env:OPENSOUL_SKIP_CHANNELS = "1"
$env:OPENSOUL_GATEWAY_TOKEN = "dev-token"
node scripts/run-node.mjs --dev gateway

Service Management

Command	Description
opensoul onboard --install-daemon	Install as background service
opensoul service start	Start the service
opensoul service stop	Stop the service
opensoul service status	Service status

Logs

opensoul logs              # View recent logs
opensoul logs --tail       # Live log tailing
opensoul logs --verbose    # Verbose output

Related Pages

• Getting Started — Quick start with the CLI
• Configuration — Config management
• Troubleshooting — Common CLI issues