DebugBundle
CLI

CLI

Install and authenticate the DebugBundle CLI. Manage incidents, bundles, tokens, webhooks, and alerts from the terminal.

What the CLI Does

The DebugBundle CLI is your primary interface for:

  • Local-first debugging — Setup, capture, process, inspect, and resolve incidents without any cloud account
  • Cloud management — Connect a project, verify ingestion, manage tokens and webhooks
  • Agent integration — Every command outputs structured --json for AI-agent consumption via MCP or direct invocation
  • Log ingestion — Ingest and tail-watch log files with first-party parsers

Installation

npm install -g @debugbundle/cli

Or as a project dev dependency:

npm install --save-dev @debugbundle/cli

Verify installation:

debugbundle --help

Authentication

The CLI uses two authentication modes:

ModeToken PrefixUse Case
Local-onlyNo token neededsetup, process, inspect, doctor — everything local
Connecteddbundle_mem_*Cloud retrieval, token management, webhook CRUD, billing

Login

debugbundle login dbundle_mem_xxxxxxxxxxxx

This saves your member token to ~/.debugbundle/auth.json. All subsequent cloud commands use this token automatically.

Customize the API base URL:

debugbundle login dbundle_mem_xxxxxxxxxxxx --base-url https://api.self-hosted.example.com

Verify Identity

debugbundle whoami

Global Flags

Every command supports these flags:

FlagDescription
--jsonOutput machine-readable JSON instead of human-readable text
--auth-file <path>Override the default auth file location (cloud commands only)

Exit Codes

CodeMeaning
0Success
1Internal error
2Authentication error
3Resource not found
4Input validation error

Command Index

Local Workflow

CommandDescription
setupInitialize the DebugBundle scaffold in your project
doctorHealth check: profile, connection, auth, local state
processProcess local events into incidents and bundles
validateCheck scaffold files exist and are valid
cleanRemove local events, bundles, or both
analyzeRun analysis recipes on local incidents

Incident Management

CommandDescription
incidentsList incidents (local, cloud, or both)
inspect <id>View full incident detail
resolve <id>Mark an incident as resolved
reopen <id>Reopen a resolved incident
bundle <id>Retrieve the debug bundle for an incident
reproduce <id>Get reproduction artifacts (curl, httpie, JSON spec)
logs <id>View event logs for an incident

Ingestion

CommandDescription
ingest <file>Ingest a log file as events
watchTail-watch a log file and continuously ingest

Cloud Operations

CommandDescription
login <token>Authenticate with a member token
whoamiShow current auth identity
connectLink local project to a cloud project
verify localVerify the local scaffold is healthy
verify cloudVerify cloud ingestion is working
smokeEnd-to-end smoke test for cloud ingestion

Resource Management

CommandDescription
servicesList services for a project
token project list/create/revokeManage project tokens (SDK write-only)
token member list/create/revokeManage member tokens (CLI/API/MCP)
webhook list/create/update/delete/testManage webhooks
webhook deliveries/retryView and retry webhook deliveries
alert list/create/update/deleteManage alert rules
billing getView billing summary
billing capacity increase/schedule-reduction/cancel-reductionManage billing capacity
weekly-report list/create/update/deleteManage weekly reports
capture-policy get/setView and update capture policy
project list/create/update/deleteManage projects
probe activate/list/deactivateManage debug probes
member list/invites/invite/cancel-invite/update-role/removeManage organization members
profile validateValidate the local project profile

Next Steps

On this page