Reference
CLI commands
This page is generated from the same usage text returned by the CLI help surface.
CLI help source
debugbundle --version
debugbundle -v
debugbundle -h
debugbundle analyze [--type <improvement|failure|performance>] [--local] [--json]
Other
| Command | Usage |
|---|
| debugbundle --version |
V
| Command | Usage |
|---|
-v | debugbundle -v |
H
| Command | Usage |
|---|
-h | debugbundle -h |
Analyze
| Command | Usage |
|---|
analyze | debugbundle analyze [--type <improvement|failure|performance>] [--local] [--json] |
Doctor
| Command | Usage |
|---|
doctor | debugbundle doctor [--check-relay] [--json] |
Setup
| Command | Usage |
|---|
setup | debugbundle setup [--non-interactive] [--json] |
Connect
| Command | Usage |
|---|
connect | debugbundle connect [--auth-file <path>] [--json] |
Ingest
| Command | Usage |
|---|
ingest | debugbundle ingest <file> --format <debugbundle-ndjson|php-error|apache-error> [--json] |
Watch
| Command | Usage |
|---|
watch | debugbundle watch [--cloud] --log <file> --format <debugbundle-ndjson|php-error|apache-error> [--json] |
Process
| Command | Usage |
|---|
process | debugbundle process [--preset <minimal|balanced|investigative>] [--json] |
Clean
| Command | Usage |
|---|
clean | debugbundle clean [--events] [--bundles] [--all] [--older-than <Nd>] [--json] |
Validate
| Command | Usage |
|---|
validate | debugbundle validate [--fix] [--json] |
Verify
| Command | Usage |
|---|
verify local | debugbundle verify local [--json] |
verify cloud | debugbundle verify cloud --project-id <id> [--trigger-5xx | --trigger-4xx <400-499> | --expect-app-event [--trace-id <id>] [--request-id <id>]] [--service <name>] [--environment <name>] [--max-age-minutes <n>] [--auth-file <path>] [--json] |
Smoke
| Command | Usage |
|---|
smoke | debugbundle smoke --project-id <id> [--service <name>] [--environment <name>] [--max-age-minutes <n>] [--auth-file <path>] [--json] |
Login
| Command | Usage |
|---|
login | debugbundle login [--base-url <url>] [--auth-file <path>] [--json] |
login | debugbundle login <member-token> [--base-url <url>] [--auth-file <path>] [--json] |
login | debugbundle login --github [--label <label>] [--base-url <url>] [--auth-file <path>] [--json] |
login | debugbundle login --github-cli [--label <label>] [--base-url <url>] [--auth-file <path>] [--json] |
login | debugbundle login --github-device [--label <label>] [--base-url <url>] [--auth-file <path>] [--json] |
Profile
| Command | Usage |
|---|
profile validate | debugbundle profile validate [--json] |
Whoami
| Command | Usage |
|---|
whoami | debugbundle whoami [--auth-file <path>] [--json] |
Incidents
| Command | Usage |
|---|
incidents | debugbundle incidents [--source <local|cloud>] [--project-id <id>] [--environment <name>] [--service <name>] [--status <active|open|resolved|regressed|all>] [--severity <severity>] [--first-seen-after <ISO8601>] [--attention-after <ISO8601>] [--cursor <cursor>] [--limit <n>] [--auth-file <path>] [--json] |
Inspect
| Command | Usage |
|---|
inspect | debugbundle inspect <incident-id> [--source <local|cloud>] [--auth-file <path>] [--json] |
Explain
| Command | Usage |
|---|
explain | debugbundle explain <incident-id> [--source <local|cloud>] [--auth-file <path>] [--json] |
Resolve
| Command | Usage |
|---|
resolve | debugbundle resolve <incident-id> [incident-id ...] [--source <local|cloud>] [--auth-file <path>] [--json] |
Reopen
| Command | Usage |
|---|
reopen | debugbundle reopen <incident-id> [incident-id ...] [--source <local|cloud>] [--auth-file <path>] [--json] |
Bundle
| Command | Usage |
|---|
bundle | debugbundle bundle <incident-id> [--source <local|cloud>] [--auth-file <path>] [--json] |
Reproduce
| Command | Usage |
|---|
reproduce | debugbundle reproduce <incident-id> [--source <local|cloud>] [--auth-file <path>] [--json] |
Logs
| Command | Usage |
|---|
logs | debugbundle logs <incident-id> [--level <level>] [--cursor <cursor>] [--limit <n>] [--auth-file <path>] [--json] |
Services
| Command | Usage |
|---|
services | debugbundle services --project-id <id> [--limit <n>] [--auth-file <path>] [--json] |
Billing
| Command | Usage |
|---|
billing get | debugbundle billing get [--auth-file <path>] [--json] |
billing trial start | debugbundle billing trial start --plan <solo|team> [--auth-file <path>] [--json] |
billing capacity increase | debugbundle billing capacity increase --target-additional-capacity-units <n> [--auth-file <path>] [--json] |
billing capacity schedule-reduction | debugbundle billing capacity schedule-reduction --target-additional-capacity-units <n> [--auth-file <path>] [--json] |
billing capacity cancel-reduction | debugbundle billing capacity cancel-reduction [--auth-file <path>] [--json] |
Github
| Command | Usage |
|---|
github status | debugbundle github status [--project-id <id>] [--auth-file <path>] [--json] |
github repos | debugbundle github repos [--project-id <id>] [--auth-file <path>] [--json] |
github repo set | debugbundle github repo set <owner/repo> --project-id <id> [--auth-file <path>] [--json] |
github repo remove | debugbundle github repo remove --project-id <id> [--auth-file <path>] [--json] |
github rules | debugbundle github rules --project-id <id> [--auth-file <path>] [--json] |
github rules create | debugbundle github rules create --project-id <id> --name <name> --event <event[,event]> [--environment <env[,env]>] [--service <svc[,svc]>] --severity-min <level> --bundle-type <type> [--incident-status <status>] [--cooldown <seconds>] [--enabled <true|false>] [--auth-file <path>] [--json] |
github rules update | debugbundle github rules update <rule-id> --project-id <id> [--name <name>] [--event <event[,event]>] [--environment <env[,env]>] [--service <svc[,svc]>] [--severity-min <level>] [--bundle-type <type>] [--incident-status <status>] [--cooldown <seconds>] [--enabled <true|false>] [--auth-file <path>] [--json] |
github rules delete | debugbundle github rules delete <rule-id> --project-id <id> [--auth-file <path>] [--json] |
github deliveries | debugbundle github deliveries --project-id <id> [--status <status>] [--limit <n>] [--auth-file <path>] [--json] |
github deliveries retry | debugbundle github deliveries retry <delivery-id> --project-id <id> [--auth-file <path>] [--json] |
Project
| Command | Usage |
|---|
project list | debugbundle project list [--limit <n>] [--auth-file <path>] [--json] |
project create | debugbundle project create --name <name> --slug <slug> [--environment-default <env>] [--color-tag <tag>] [--auth-file <path>] [--json] |
project update | debugbundle project update <project-id> [--name <name>] [--slug <slug>] [--environment-default <env>] [--color-tag <tag> | --clear-color-tag] [--auth-file <path>] [--json] |
project delete | debugbundle project delete <project-id> [--auth-file <path>] [--json] |
project members list | debugbundle project members list --project-id <id> [--auth-file <path>] [--json] |
project members invites | debugbundle project members invites --project-id <id> [--auth-file <path>] [--json] |
project members invite | debugbundle project members invite --project-id <id> --email <email> --role <admin|member> [--auth-file <path>] [--json] |
project members cancel-invite | debugbundle project members cancel-invite <invite-id> --project-id <id> [--auth-file <path>] [--json] |
project members update-role | debugbundle project members update-role <user-id> --project-id <id> --role <admin|member> [--auth-file <path>] [--json] |
project members remove | debugbundle project members remove <user-id> --project-id <id> [--auth-file <path>] [--json] |
project members leave | debugbundle project members leave --project-id <id> [--auth-file <path>] [--json] |
Token
| Command | Usage |
|---|
token project list | debugbundle token project list <project-id> [--limit <n>] [--auth-file <path>] [--json] |
token project create | debugbundle token project create <project-id> --label <label> [--allowed-origin <origin> ...] [--auth-file <path>] [--json] |
token project revoke | debugbundle token project revoke <project-id> <token-id> [--auth-file <path>] [--json] |
token member list | debugbundle token member list [--limit <n>] [--auth-file <path>] [--json] |
token member create | debugbundle token member create --label <label> [--auth-file <path>] [--json] |
token member revoke | debugbundle token member revoke <token-id> [--auth-file <path>] [--json] |
Alert
| Command | Usage |
|---|
alert list | debugbundle alert list --project-id <id> [--limit <n>] [--auth-file <path>] [--json] |
alert create | debugbundle alert create --project-id <id> --channel <channel> --condition <condition> [--service-id <id>] [--severity-min <level>] [--cooldown <seconds>] --config-json <json> [--is-enabled <true|false>] [--auth-file <path>] [--json] |
alert update | debugbundle alert update <alert-id> --project-id <id> [--service-id <id|null>] [--channel <channel>] [--condition <condition>] [--severity-min <level|null>] [--cooldown <seconds>] [--config-json <json|null>] [--is-enabled <true|false>] [--auth-file <path>] [--json] |
alert delete | debugbundle alert delete <alert-id> --project-id <id> [--auth-file <path>] [--json] |
Slack
| Command | Usage |
|---|
slack list | debugbundle slack list --project-id <id> [--auth-file <path>] [--json] |
slack connect-url | debugbundle slack connect-url --project-id <id> [--return-to </projects/...>] [--auth-file <path>] [--json] |
slack test | debugbundle slack test <destination-id> --project-id <id> [--auth-file <path>] [--json] |
slack delete | debugbundle slack delete <destination-id> --project-id <id> [--auth-file <path>] [--json] |
Webhook
| Command | Usage |
|---|
webhook list | debugbundle webhook list --project-id <id> [--limit <n>] [--auth-file <path>] [--json] |
webhook create | debugbundle webhook create --project-id <id> --url <url> --event <event[,event]> [--environment <env[,env]>] [--service <svc[,svc]>] [--severity-min <level>] [--bundle-type <type[,type]>] [--verification <true|false>] [--is-enabled <true|false>] [--auth-file <path>] [--json] |
webhook update | debugbundle webhook update <webhook-id> --project-id <id> [--url <url>] [--event <event[,event]>] [--environment <env[,env]>] [--service <svc[,svc]>] [--severity-min <level>] [--bundle-type <type[,type]>] [--verification <true|false>] [--is-enabled <true|false>] [--auth-file <path>] [--json] |
webhook delete | debugbundle webhook delete <webhook-id> --project-id <id> [--auth-file <path>] [--json] |
webhook test | debugbundle webhook test <webhook-id> --project-id <id> [--event <verification.passed|verification.failed>] [--auth-file <path>] [--json] |
webhook deliveries | debugbundle webhook deliveries <webhook-id> --project-id <id> [--limit <n>] [--auth-file <path>] [--json] |
webhook retry | debugbundle webhook retry <webhook-id> <delivery-id> --project-id <id> [--auth-file <path>] [--json] |
Weekly Report
| Command | Usage |
|---|
weekly-report list | debugbundle weekly-report list --project-id <id> [--limit <n>] [--auth-file <path>] [--json] |
weekly-report create | debugbundle weekly-report create --project-id <id> --channel <email|slack> --day-of-week <day> --hour-of-day <0-23> --timezone <iana> --config-json <json> [--is-enabled <true|false>] [--auth-file <path>] [--json] |
weekly-report update | debugbundle weekly-report update <channel-id> [--day-of-week <day>] [--hour-of-day <0-23>] [--timezone <iana>] [--config-json <json>] [--is-enabled <true|false>] [--auth-file <path>] [--json] |
weekly-report delete | debugbundle weekly-report delete <channel-id> [--auth-file <path>] [--json] |
Capture Policy
| Command | Usage |
|---|
capture-policy get | debugbundle capture-policy get --project <id> [--auth-file <path>] [--json] |
capture-policy set | debugbundle capture-policy set --project <id> [--preset <minimal|balanced|investigative>] [--override <key=value>] [--client-error-incidents <preset-default|none|recommended|custom>] [--client-error-statuses <400,401,...>] [--client-error-path-rule <404=/path/*@GET,POST>] [--client-error-path-rules-json <json|null>] [--auth-file <path>] [--json] |
Capture Rule
| Command | Usage |
|---|
capture-rule list | debugbundle capture-rule list --project-id <id> [--auth-file <path>] [--json] |
capture-rule suggest | debugbundle capture-rule suggest <incident-id> [--auth-file <path>] [--json] |
capture-rule create-from-suggestion | debugbundle capture-rule create-from-suggestion <incident-id> --suggestion-id <id> [--name <name>] [--description <text>] [--enabled <true|false>] [--expires-at <ISO8601>] [--auth-file <path>] [--json] |
capture-rule create | debugbundle capture-rule create --project-id <id> --name <name> --action <demote|sample|drop> --matcher-json <json> [--description <text>] [--enabled <true|false>] [--sample-rate <0-1>] [--sample-event-class <preserve|context>] [--expires-at <ISO8601>] [--auth-file <path>] [--json] |
capture-rule update | debugbundle capture-rule update <rule-id> --project-id <id> [--name <name>] [--description <text>] [--enabled <true|false>] [--action <demote|sample|drop>] [--matcher-json <json>] [--sample-rate <0-1>] [--sample-event-class <preserve|context>] [--expires-at <ISO8601>] [--auth-file <path>] [--json] |
capture-rule delete | debugbundle capture-rule delete <rule-id> --project-id <id> [--auth-file <path>] [--json] |
Improvements
| Command | Usage |
|---|
improvements list | debugbundle improvements list [--project-id <id>] [--environment <name>] [--service <name>] [--status <status>] [--severity <level>] [--kind <kind>] [--cursor <cursor>] [--limit <n>] [--auth-file <path>] [--json] |
improvements get | debugbundle improvements get <improvement-id> [--auth-file <path>] [--json] |
improvements bundle | debugbundle improvements bundle <improvement-id> --project-id <id> [--auth-file <path>] [--json] |
improvements resolve | debugbundle improvements resolve <improvement-id> [--auth-file <path>] [--json] |
improvements reopen | debugbundle improvements reopen <improvement-id> [--auth-file <path>] [--json] |
improvements snooze | debugbundle improvements snooze <improvement-id> --until <ISO8601> [--auth-file <path>] [--json] |
improvements settings get | debugbundle improvements settings get --project <id> [--auth-file <path>] [--json] |
improvements settings set | debugbundle improvements settings set --project <id> [--enabled <true|false>] [--sensitivity <high_confidence|balanced|verbose>] [--auth-file <path>] [--json] |
Probe
| Command | Usage |
|---|
probe activate | debugbundle probe activate <project-id> --label-pattern <pattern> [--service <name>] [--environment <name>] [--ttl-seconds <n>] [--trigger-ttl-seconds <n>] [--auth-file <path>] [--json] |
probe list | debugbundle probe list <project-id> [--auth-file <path>] [--json] |
probe deactivate | debugbundle probe deactivate <project-id> <activation-id> [--auth-file <path>] [--json] |
Health
| Command | Usage |
|---|
health checks list | debugbundle health checks list --project-id <id> [--limit <n>] [--auth-file <path>] [--json] |
health checks get | debugbundle health checks get <check-id> --project-id <id> [--auth-file <path>] [--json] |
health checks create | debugbundle health checks create --project-id <id> --name <name> --url <url> --interval-seconds <n> [--method <GET|HEAD>] [--expected-status-min <code>] [--expected-status-max <code>] [--timeout-ms <n>] [--failure-threshold <n>] [--recovery-threshold <n>] [--environment <name>] [--service <name|null>] [--enabled <true|false>] [--auth-file <path>] [--json] |
health checks update | debugbundle health checks update <check-id> --project-id <id> [--name <name>] [--url <url>] [--method <GET|HEAD>] [--expected-status-min <code>] [--expected-status-max <code>] [--timeout-ms <n>] [--interval-seconds <n>] [--failure-threshold <n>] [--recovery-threshold <n>] [--environment <name>] [--service <name|null>] [--enabled <true|false>] [--auth-file <path>] [--json] |
health checks delete | debugbundle health checks delete <check-id> --project-id <id> [--auth-file <path>] [--json] |
health checks test | debugbundle health checks test --project-id <id> --url <url> [--method <GET|HEAD>] [--expected-status-min <code>] [--expected-status-max <code>] [--timeout-ms <n>] [--auth-file <path>] [--json] |
health checks results | debugbundle health checks results <check-id> --project-id <id> [--limit <n>] [--auth-file <path>] [--json] |
health checks daily-rollups | debugbundle health checks daily-rollups <check-id> --project-id <id> [--limit <n>] [--auth-file <path>] [--json] |
