disbug-cli

module
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 25, 2026 License: MIT

README

disbug

Disbug CLI and MCP server for AI coding agents.

A single Go binary that reads bug-report sessions from your team's Disbug instance, plus downloaded local report JSON files. Use the CLI from shell-capable agents, or connect its MCP server to an MCP-native agent.

Install

macOS / Linux (Homebrew)
brew install disbug-io/tap/disbug
Windows (Scoop)
scoop bucket add disbug https://github.com/disbug-io/scoop-bucket
scoop install disbug
Direct download

Grab a binary for your OS/arch from Releases and put it on your PATH.

Quickstart

disbug login                 # authenticate in the browser
disbug configure             # connect detected agents and install the workflow skill
disbug doctor                # verify login, backend, MCP, and skill setup
disbug sessions --status open
disbug session https://app.disbug.io/acme/projects/2/sessions/5/
disbug pin 'https://app.disbug.io/acme/projects/2/sessions/5/?pin=1' --fields console,network
disbug attachment download 'https://app.disbug.io/acme/projects/2/sessions/5/?pin=1' 42 --output ./notes.md
disbug pin status 'https://app.disbug.io/acme/projects/2/sessions/5/?pin=1' resolved --note 'Fixed and verified checkout validation.'
disbug session status https://app.disbug.io/acme/projects/2/sessions/5/ resolved --note 'All reported pins verified.'
disbug inspect ./disbug-report-example.json

disbug configure currently supports Codex, Claude Code, and Cursor. It shows the files it will change and asks for confirmation. For non-interactive setup, select an agent explicitly, for example disbug configure --agent codex --yes.

The installed using-disbug skill teaches investigation workflow and capability selection. Command syntax remains in disbug --help and disbug <command> --help; MCP tool syntax remains in each tool's schema.

Inspect a downloaded local report

The Chrome extension can download a self-contained local report JSON when a user does not want to save a session to cloud. Inspect it without dumping screenshots or replay bytes into the terminal:

disbug inspect ./disbug-report-example.json
disbug inspect ./disbug-report-example.json --pin 2 --fields console,network
disbug inspect ./disbug-report-example.json --pin 2 --fields screenshot,replay

screenshot and replay fields are decoded to local cache file paths only when requested. The default summary prints pin feedback, URLs, artifact availability, and log counts.

Use as an MCP server

Disbug exposes read MCP tools for cloud reports: whoami, list_sessions, get_session, get_pin, get_pins, download_attachment, search_sessions, and search_pins. Session and pin results include attachment filenames and IDs; download_attachment returns the selected file's content directly to the agent. Explicit status writes use set_session_status and set_pin_status; both accept an optional agent note.

For downloaded local report JSON files, use inspect_local_report with a filesystem path. It returns the same lightweight summary as disbug inspect, and can inspect a single pin with selected fields without needing native host setup or a cloud upload.

Run disbug configure for Codex, Claude Code, or Cursor. Manual setup recipes and unsupported-client fallbacks are also available:

Multi-profile
disbug --profile work login
disbug --profile work configure
disbug --profile personal login
disbug --profile personal configure

Each configured profile points the selected agent at disbug --profile <name> mcp.

Exit codes

Code Meaning
0 OK
2 Usage error (bad ref, bad flag)
4 Auth error (no token, 401)
5 Network unreachable
6 Not found (404)
7 Forbidden (403, including free-tier locked)
8 Rate limited (429)
9 Server error (5xx)

Development

make install-hooks
make ci

The pre-commit hook runs make fmt-check and make lint.

For release and package publishing, see docs/release.md.

License

MIT - see LICENSE.

Directories

Path Synopsis
cmd
disbug command
internal
client/openapi
Package openapi provides primitives to interact with the openapi HTTP API.
Package openapi provides primitives to interact with the openapi HTTP API.
cmd
mcp
Package mcp registers the Disbug MCP tools and runs the stdio JSON-RPC server.
Package mcp registers the Disbug MCP tools and runs the stdio JSON-RPC server.
ref
selfupdate
Package selfupdate performs a best-effort check for a newer released disbug CLI and formats an upgrade nudge.
Package selfupdate performs a best-effort check for a newer released disbug CLI and formats an upgrade nudge.
ui

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL