Skip to main content
CommandDescriptionExample
debug --helpShow usage help and exit.debug --help
debug --version / -vPrint the installed OpenBug CLI version and exit.debug --version
debug init [-id <id>] -m <desc>Initialize OpenBug configuration and create/update openbug.yaml.debug init -id openbug-service -m "Node.js API"
debug login <auth-key>Save your API key into ~/.openbug/config.debug login abc123xyz789
debugStart the local WebSocket cluster server and the AI chat interface.debug
debug <command>...Run any shell command under OpenBug’s interactive debugging.debug npm run dev

​
oncall init options

Initializes configuration for the current project and writes oncall.yaml.
  • -m <description> (required): Human-readable description of the service.
  • -id <project-id> (optional): Project identifier used to group services into a cluster. If omitted, you will be prompted to enter one interactively.
Example: 
oncall init -id my-app -m "Node.js REST API backend"

​
debug login arguments

Stores your API key in ~/.openbug/config:
  • <auth-key> (required): Obtain this from the OnCall dashboard (app.oncall.build).
Example: 
debug login abc123xyz789

​
debug

Starts AI Chat Interface:
  • Lets the user to ask questions on the active sessions available.
  • Lets user understand what is going wrong in his service.
Starts a local WebSocket server in the background (ws://127.0.0.1:4466 by default) that:
  • Registers services when you run debug <command> in directories with openbug.yaml.
  • Keeps a registry of all services for each project id.
  • Lets the OpenBug debugging service see your app’s architecture (services + access flags).
The command does not accept additional arguments. Stop the server with Ctrl+C in that terminal.
Example: 
debug

​
debug <command>...

Wraps any shell command with OpenBug’s interactive debugging interface:
  • The command is executed via a pseudo-terminal.
  • Logs are streamed into the OpenBug UI.
  • You can ask questions in the chat pane while the command runs.
  • The OpenBug debugging service may use tools (logs/code) according to your openbug.yaml flags.
Examples: 
debug npm run dev
debug python app.py
debug docker-compose up
debug node server.js --port 3000

​
Global flags

FlagDescription
--help, -hPrint usage help and exit.
--version, -vPrint the installed OnCall CLI version and exit.
These flags are handled before any subcommand or wrapped command is executed.