cgh-bugreport

Crash reports for cgh that keep the promise the rest of the product makes: nothing leaves the machine without a gate, and you see exactly what would.

pip install cgh-bugreport     # capture only: reports spool locally
cgh bug status                # the ledger: spooled, sent, where, when
cgh bug preview last          # the exact raw payload, byte for byte
cgh bug send                  # explicit, always; to a PRIVATE repo only
cgh bug purge                 # drop spooled reports

Two properties carry the design:

  • The core never phones home. All reporting lives in this plugin. A cgh install without it provably has no reporting code at all, and even with it, the plugin itself has no network code: sending goes through your own gh CLI and its credentials.
  • Payloads are built by allowlist, never by scrubbing. A report contains versions, OS name, the failing command name, the exception TYPE, and stack frames normalized to cgh's own modules (anything outside reduces to <external>). Exception messages, file paths, arguments and log lines are not fields, so they structurally cannot leave. The PII scanner runs over the finished payload as a tripwire and fails the build loudly if it ever matches.

Sending is always manual (auto_send does not exist), refuses public repositories, dedups by fingerprint (new occurrences comment on the existing issue), and every send lands in .codegraph/activity.log. With mode = "secure" the payload is shown and confirmed before anything leaves. Spool: capped at 20 reports, purged after 30 days, never indexed by cgh itself.

[plugin.bugreport]
# github_repo = "your-org/cgh-crash-reports"   # must be private

Known tradeoff, stated: sending through your gh credentials links the report to your GitHub identity. The private repo bounds the audience; the preview shows there is nothing sensitive to link.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for joy-soft from gravatar.com joy-soft

Credits

Author: Joy Ndjama

License expression

MIT AND CC-BY-NC-SA-4.0
View SPDX License List

Requires

Python >=3.11

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cgh_bugreport-0.1.1.tar.gz (11.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cgh_bugreport-0.1.1-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

Details for the file cgh_bugreport-0.1.1.tar.gz.

File metadata

  • Download URL: cgh_bugreport-0.1.1.tar.gz
  • Upload date:
  • Size: 11.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for cgh_bugreport-0.1.1.tar.gz
Algorithm Hash digest
SHA256 65a943afbd66865bcc9a5755ee7f879339b7630a9b7606ac3ca073b5f2516e28
MD5 772799f78c92c860d6a261ab47802fad
BLAKE2b-256 640fb314221c400979a024fd9f328a9490a8f364cbab06fa733c862e03bdb088

See more details on using hashes here.

Provenance

The following attestation bundles were made for cgh_bugreport-0.1.1.tar.gz:

Publisher: release.yml on altikva/cgh

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cgh_bugreport-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: cgh_bugreport-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 10.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for cgh_bugreport-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f7f6cd70ef3900180628be36151ebad378becefa922b7187e58911e6e48dda1a
MD5 56aa473a4b99eb5755b09613cf1386fe
BLAKE2b-256 b51d5cb872925343d6651e7dea9933e24542576b798883096504458ead53176e

See more details on using hashes here.

Provenance

The following attestation bundles were made for cgh_bugreport-0.1.1-py3-none-any.whl:

Publisher: release.yml on altikva/cgh

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 files

0.1.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page