HeadlinesBriefing favicon HeadlinesBriefing.com

Debug Brief CLI turns debugging into markdown reports

Hacker News •
×

GitHub user harihkk released Debug Brief, a local‑first CLI that records a debugging session and outputs a markdown brief suitable for pull‑request comments, handoffs or incident notes. The tool captures notes, commands, exit codes and changed files, then assembles a report that shows what was tried, what failed, what passed, and which files changed. It runs on Python 3.9+ and requires no AI or telemetry.

Installation is straightforward: pipx, pip or the Oruv tool can install the package, and an alias like `db="debugbrief run --"` hides the capture prefix for daily use. When a recognized test runner such as pytest, jest or go test exits zero, Debug Brief marks the command verified; otherwise it records the raw outcome. Secrets are redacted by default, with a `--no-redact` override for specific commands.

The generated markdown includes a concise summary, a red‑to‑green timeline, the files touched between failure and success, and optional sections for reproducing steps. Because it relies only on the Python standard library and native Git, it works on Linux and macOS without additional dependencies, but it does not support Windows shells. Licensed under MIT, Debug Brief provides an auditable, zero‑telemetry alternative to AI‑driven debugging assistants.