Commands Overview¶
Many of these operations also have UI equivalents in the desktop app and web console (service control, backend and model selection, settings) and in the iOS app (threads, approvals, voice). The CLI is the layer underneath all of them.
Openbase CLI command structure:
Global Options¶
| Option | Description |
|---|---|
--version |
Print CLI version and exit |
--help |
Show help |
Top-Level Commands¶
| Command | Description |
|---|---|
backend |
View or switch the selected coding backend |
claude |
Start Claude Code with Openbase's profile; inspect its login |
codex |
Start Codex with Openbase's profile, attached to the managed app-server |
threads |
List the Codex and Claude Code sessions open in terminals, send one a message, and maintain threads |
claude-sync |
Synchronize Claude Code session snapshots across devices |
codex-sync |
Synchronize Codex session snapshots across devices |
defaults |
Manage default dispatcher and Super Agents model/reasoning settings |
setup |
Full local bootstrap flow |
server |
Run local Django/ASGI server |
service |
Publish a local HTTP service privately over the Openbase VPN |
restart |
Restart Openbase-managed services |
sync |
Inspect Openbase Sync, resolve conflicts, and migrate from the previous sync |
sync-daemon |
Configure and manage Openbase Sync between two of your computers |
self-update |
Update a standalone install to the latest release |
version |
Print CLI and package versions plus update availability |
services |
Manage launchd services |
doctor |
Verify install, service health, and secrets |
onboarding |
Inspect onboarding state and report it to Openbase cloud |
login |
Email-code login to Openbase cloud |
loops |
Manage loops: scheduled or event-triggered agent prompts and commands (alias: routines) |
mcp-gateway |
Make MCP servers bound to one machine (such as your laptop's screen) available to agents on another |
logout |
Remove saved auth tokens |
plugins |
Install and manage Openbase plugins |
profiles |
Install or repair Openbase conversation profiles and session-ID hooks |
bootstrap |
Run plugin-provided bootstrap commands |
voice routing |
Route the active LiveKit voice room between the dispatcher and Super Agents |
Common Examples¶
# Full bootstrap
openbase-coder setup
# Start API server
openbase-coder server --host 0.0.0.0 --port 7999
# Check service states
openbase-coder services status
# Share a local development site with other tailnet devices
openbase-coder service publish docs-preview 3000
# Switch coding backend
openbase-coder backend use codex
# Restart Openbase-managed services
openbase-coder restart
# Check or change the active voice route
openbase-coder user voice-route
openbase-coder user transfer-to-agent "Lucy"
openbase-coder exit-to-dispatch
# Tail logs for one service
openbase-coder services logs django-cli
# Validate local environment
openbase-coder doctor
# Install plugin from local repo
openbase-coder plugins add ~/code/my-openbase-plugin
# List plugin-provided bootstrappers
openbase-coder plugins bootstrappers
# Run a bootstrapper
openbase-coder bootstrap django-app --params-file bootstrap.json