Projects CLI reference

The projects command lets you manage Honeybadger projects and view reports.

List projects

hb projects list

# Filter by account
hb projects list --account-id 12345

Optional flags:

• --account-id — Filter projects by account ID
• -o, --output — Output format: table or json (default: table)

Get project details

hb projects get --id 12345

Required flags:

• --id — Project ID

Optional flags:

• -o, --output — Output format: text or json (default: text)

Create a project

hb projects create --account-id 12345 --cli-input-json '{
  "project": {
    "name": "My Project",
    "language": "ruby",
    "resolve_errors_on_deploy": true
  }
}'

# Or from a file
hb projects create --account-id 12345 --cli-input-json file://project.json

Required flags:

• --account-id — Account ID to create the project in
• --cli-input-json — JSON payload (inline string or file://path)

JSON fields:

• name — Project name
• language — Programming language
• resolve_errors_on_deploy — Auto-resolve errors on deploy
• disable_public_links — Disable public error links
• user_url — URL template for user links (e.g., https://myapp.com/users/[user_id])
• source_url — URL template for source links (e.g., https://github.com/org/repo/blob/main/[filename]#L[line])
• purge_days — Days to retain data
• user_search_field — Field to use for user search

Optional flags:

• -o, --output — Output format: text or json (default: text)

Update a project

hb projects update --id 12345 --cli-input-json '{"project": {"name": "New Name"}}'

Required flags:

• --id — Project ID
• --cli-input-json — JSON payload with fields to update

Optional flags:

• -o, --output — Output format: text or json (default: text)

Delete a project

hb projects delete --id 12345

Required flags:

• --id — Project ID

---

Get occurrence counts

View error occurrence counts across projects:

# All projects
hb projects occurrences --period day --environment production

# Specific project
hb projects occurrences --id 12345 --period hour

Optional flags:

• --id — Project ID (omit for all projects)
• --period — Time period: hour, day, week, or month (default: day)
• --environment — Filter by environment
• -o, --output — Output format: table or json (default: table)

Get integrations

List integrations configured for a project:

hb projects integrations --id 12345

Required flags:

• --id — Project ID

Optional flags:

• -o, --output — Output format: table or json (default: table)

Get reports

Generate reports for a project:

hb projects reports --id 12345 --type notices_per_day \
  --start 2024-01-01T00:00:00Z \
  --stop 2024-01-31T23:59:59Z

Required flags:

• --id — Project ID
• --type — Report type:
  • notices_by_class — Errors grouped by class
  • notices_by_location — Errors grouped by location
  • notices_by_user — Errors grouped by user
  • notices_per_day — Error count over time

Optional flags:

• --start — Start time in RFC3339 format
• --stop — Stop time in RFC3339 format
• --environment — Filter by environment
• -o, --output — Output format: table or json (default: table)