Skip to main content

Watch for errors streaming from ghosttrap.io

Project description

ghosttrap-cli

The developer-side listener for ghosttrap. Connects errors from remote servers to Claude Code in real time.

Works with any Python app. Django and Celery get deep integration (middleware, app config, task failure hooks). Flask and other frameworks work via Python's logging and excepthook.

Setup

Requires the GitHub CLI (gh) and Claude Code.

pip install ghosttrap-cli
cd ~/your-project
ghosttrap setup

Then in Claude Code:

/ghosttrap

That's it. setup authenticates via gh, claims the repo, and installs a Claude Code skill. The /ghosttrap skill handles everything else — it installs the SDK into your app, wires in the error hooks, and starts monitoring.

What happens next

The skill file tells Claude Code to run ghosttrap peek in the background. Peek opens a WebSocket to ghosttrap.io and waits. When a production error arrives, Claude sees the full traceback — exception type, message, file, line, function — and starts fixing.

After fixing, Claude restarts peek and waits for the next one. Errors become a real-time stream that your AI agent dispatches automatically.

The SDK

Your app needs ghosttrap-sdk to report errors. The Claude Code skill handles the integration automatically — it installs the SDK, wires it into your app, and adds Django/Celery hooks if applicable. You shouldn't need to touch the SDK manually.

If you want to manually flag a caught exception or a non-exception condition, call ghosttrap.trap(exc_or_message) from your app code — see the SDK README.

Commands

Command What it does
ghosttrap setup Claim a repo, install the Claude Code skill
ghosttrap peek Wait for the next error, print it, exit
ghosttrap peek --clear Skip outstanding errors, then wait for the next one
ghosttrap last Fetch the most recent error and exit (no waiting)
ghosttrap last --clear Fetch the most recent error and skip everything older
ghosttrap watch Deprecated — peek reconnects until an error arrives, which covers the streaming case
ghosttrap list [n] Print a numbered summary of the most recent n errors (default 10, max 50). Doesn't move the cursor.
ghosttrap show <i> Full details for row i from the last list (1-based). Doesn't move the cursor.
ghosttrap clear Skip all outstanding errors
ghosttrap nuke Permanently delete every server-side row for the current repo (errors + token). Requires typed confirmation.

Every command except setup and nuke accepts --repo owner/name to target a specific claimed repo when you're not inside its working tree (e.g. ghosttrap peek --repo alex-rowley/ghosttrap-cli). Otherwise the repo is detected from cwd. nuke is intentionally cwd-locked.

How it works

  • Setup authenticates with GitHub (via the active gh account) to prove you have access to the repo, then saves a repo token locally. If your active gh account can't see the repo, setup fails with a clear message; switch with gh auth switch and retry.
  • Peek connects to ghosttrap.io using that token — no GitHub auth needed after setup
  • If the connection drops or the server closes an idle socket, peek reconnects with a 60-second backoff for as long as it runs — it only exits once it has delivered an error (or hit a real failure, which it reports on stderr)
  • Errors that arrive while you're offline are replayed on next connect (cursor-based, no duplicates)
  • Repos are tracked by GitHub's immutable repo id, so a rename or transfer doesn't require any action — the next connect picks up the new owner/name and your token keeps working
  • Local state is stored in ~/.ghosttrap/config.json, keyed by GitHub repo id

Requirements

  • Python 3.10+
  • GitHub CLI (gh) — used for authentication during setup
  • Claude Code — the AI agent that fixes your errors
  • macOS or Linux (Windows is untested)

Privacy

Error data (tracebacks, exception messages, file paths) is routed through ghosttrap.io. The server is not open source yet — if there's demand for self-hosting, we'll open it up. Your GitHub token is used only during setup to verify repo access; it's never stored on the server. After setup, all communication uses a repo-specific token that grants access only to that repo's error stream — it cannot access your GitHub account.

User context (Django user id + username) is never sent unless you opt in with ghosttrap.init(token, send_user=True) in your app. Server hostname is captured automatically.

Run ghosttrap nuke from inside a repo to permanently delete every server-side row for that repo (errors + the token itself). Requires typing the repo name to confirm.

Project details


Download files

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

Source Distribution

ghosttrap_cli-0.3.25.tar.gz (14.4 kB view details)

Uploaded Source

Built Distribution

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

ghosttrap_cli-0.3.25-py3-none-any.whl (13.3 kB view details)

Uploaded Python 3

File details

Details for the file ghosttrap_cli-0.3.25.tar.gz.

File metadata

  • Download URL: ghosttrap_cli-0.3.25.tar.gz
  • Upload date:
  • Size: 14.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ghosttrap_cli-0.3.25.tar.gz
Algorithm Hash digest
SHA256 e76c8d6b5c8f68cb65cdf603d794b5128e218a6c9cc1cee64c0f530dba0983a0
MD5 b0fbd01d52ae6ec7dace7104f93a2173
BLAKE2b-256 d66c1beef33f0c09a43752e298dff99a1219087a6eb59a219d8bdb28db25e795

See more details on using hashes here.

File details

Details for the file ghosttrap_cli-0.3.25-py3-none-any.whl.

File metadata

  • Download URL: ghosttrap_cli-0.3.25-py3-none-any.whl
  • Upload date:
  • Size: 13.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ghosttrap_cli-0.3.25-py3-none-any.whl
Algorithm Hash digest
SHA256 9ca76657f5df2ee471515198e29c4dc65ddfd74957d3c375e4aecc6bcb0a7751
MD5 bd135e753786a39efb9386178ee118bf
BLAKE2b-256 57d2db1188e8db30eaa7f2cae8e40932ab4e72a80385615319c63253e46bc44c

See more details on using hashes here.

Supported by

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