Skip to main content

DebtPilot

Track technical debt before it blows up in production.

Every IDE catches syntax errors. DebtPilot does something no IDE can — it knows that payments/stripe.js has been edited 30 times by 4 different developers, has a TODO from 8 months ago, and a complexity score of 24. That combination is your next production incident.


Install

pip install debtpilot

Full install (file watcher + live notifications):

pip install "debtpilot[full]"


Quickstart — 4 commands, done

  1. Scan your project debtpilot scan .

  2. See the report debtpilot report

  3. Block bad commits automatically debtpilot hook --install

  4. Start live background watching debtpilot start --dir .


What it does

Command What happens
debtpilot scan . Scores every file 0-100 for technical debt
debtpilot report Shows top debt files in a ranked table
debtpilot file <path> Deep breakdown of one file
debtpilot ai <path> AI explains exactly what to fix (needs Gemini key)
debtpilot predict Predicts which file will cause your next bug
debtpilot dashboard Generates an HTML dashboard — open in browser
debtpilot report-pdf Generates a print-ready PDF report
debtpilot alerts Shows active danger alerts
debtpilot todos Lists stale TODOs by age
debtpilot hook --install Blocks commits above the debt threshold
debtpilot start Starts live file watcher + WebSocket server
debtpilot status Full health check of your DebtPilot setup
debtpilot digest --send Sends weekly email summary to your team

Debt Score (0-100)

Grade Score Meaning
A 0-25 Healthy
B 26-45 Watch
C 46-65 Concerning
D 66-80 Dangerous
F 81-100 Critical — fix before next deploy

Score = weighted combination of: git churn (30%) + complexity (25%) + lint issues (20%) + stale TODOs (15%) + staleness (10%).


Where your data lives

Scan results are stored per project, in a .debtpilot/ folder at your project root (found the same way git finds its root). Two different projects scanned on the same machine never share data. The folder self-ignores via its own .gitignore, so you'll never accidentally commit your scan database.

Your global settings (Gemini API key, email digest config) live separately in ~/.debtpilot/config.json — those are per-user, not per-project.


AI Fix Suggestions (optional)

Get a free Gemini API key at aistudio.google.com then:

debtpilot config --gemini-key YOUR_KEY debtpilot ai src/payments.py

DebtPilot sends the file context to Gemini and gets back exact fix suggestions with code examples and effort estimates.


Weekly Email Digest

debtpilot config --gmail you@gmail.com --gmail-password YOUR_APP_PASS --recipients team@company.com debtpilot digest --send

Use a Gmail App Password from: myaccount.google.com/apppasswords


Auto-start on Windows login

debtpilot autostart --install --dir .

DebtPilot will start silently in the background every time Windows starts. No manual debtpilot start needed.


Requirements

  • Python 3.10 or higher
  • git in PATH
  • pylint / mypy / eslint — optional, for richer lint scores

License

MIT

Download files

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

Source Distribution

debtpilot-0.3.0.tar.gz (57.9 kB view details)

Uploaded Source

Built Distribution

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

debtpilot-0.3.0-py3-none-any.whl (62.5 kB view details)

Uploaded Python 3

File details

Details for the file debtpilot-0.3.0.tar.gz.

File metadata

  • Download URL: debtpilot-0.3.0.tar.gz
  • Upload date:
  • Size: 57.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.0

File hashes

Hashes for debtpilot-0.3.0.tar.gz
Algorithm Hash digest
SHA256 a5ed9e12c491d9e9bac3fefd9b67ffee033ab530cf9106bcdbda4b21e6ff7fce
MD5 000f1c04d87cf1de52d50e5dca7720fb
BLAKE2b-256 69b83e740487bec274b51bd6b907dfb122b49fb4a73ec4eb5ae4267c0d6702fe

See more details on using hashes here.

File details

Details for the file debtpilot-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: debtpilot-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 62.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.0

File hashes

Hashes for debtpilot-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2ae5f6ffa695243924a9e020083ff54b0ed98b8b468e65a6ce10e6c001648530
MD5 88a3601f9ba2d74816dd780584773f13
BLAKE2b-256 37c7fe1783b29018ecb8641517352d3c0b1e58875fb178873c09cfa157cb0a63

See more details on using hashes here.

Release history Release notifications | RSS feed

0.4.0

2 files

This release

0.3.0 This release

2 files

0.2.0

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page