Skip to main content

AI-powered technical debt scanner for codebases

Project description

debtscanner

debtscanner is a Python CLI that scans codebases for technical debt using AI and produces prioritized results in terminal and HTML.

Install

pip install -e .

Configure

Create a .env file in the project root:

GITHUB_TOKEN=ghp_your_token_here

Or export GITHUB_TOKEN in your shell.

Commands

debtscanner scan .
debtscanner scan src/ --output report.html
debtscanner report
debtscanner fix auth.py

Options

  • --ignore: skip specific folders (repeatable or comma-separated)
  • --severity: minimum level to include (LOW, MEDIUM, HIGH, CRITICAL)

Supported languages

  • .py, .js, .ts, .jsx, .tsx, .java, .go, .rb

Behavior

  • Skips: node_modules, .git, __pycache__, dist, build, .env
  • Skips files larger than 100KB with warning
  • Skips binary files automatically
  • Retries once on API rate limits with a 2-second pause

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

debtscanner-0.2.1.tar.gz (13.6 kB view details)

Uploaded Source

Built Distribution

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

debtscanner-0.2.1-py3-none-any.whl (14.6 kB view details)

Uploaded Python 3

File details

Details for the file debtscanner-0.2.1.tar.gz.

File metadata

  • Download URL: debtscanner-0.2.1.tar.gz
  • Upload date:
  • Size: 13.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.11

File hashes

Hashes for debtscanner-0.2.1.tar.gz
Algorithm Hash digest
SHA256 1cadb681a5d7cefd77eb11c73d209d20f455598a304dbd0008a98094a0c5dc29
MD5 e541f1a39280343f98d6b35cf5f14a9c
BLAKE2b-256 e984e94539f3fa2251ffc4fc97e39bae7f6c5d768383ec2bf64783e7b1959fdc

See more details on using hashes here.

File details

Details for the file debtscanner-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: debtscanner-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 14.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.11

File hashes

Hashes for debtscanner-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 53830562cecad558d9707780b2cb4842b9fe3400e58e035f0b342a6a8b5906cb
MD5 24649585bfe43844c73b29dcaf742a5c
BLAKE2b-256 da0f8d9a3d8dd6bc06554cef8c2927f800eef4071e94aca8586b29f59c794f3c

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