Skip to main content

Turn any codebase into an AI-ready prompt context pack.

Project description

PromptMint

Turn any codebase into an AI-ready prompt.

PromptMint scans your project, collects useful source files, dependency manifests, git diff, and optional error logs, then generates a clean Markdown context pack you can paste into ChatGPT, Claude, Gemini, or any coding agent.

Why?

Copying files into AI chats is slow and messy. PromptMint gives you one command that creates a structured, safe context file for debugging, code review, refactoring, and project explanation.

Install

pip install promptmint

Install locally for development

git clone https://github.com/YOUR_USERNAME/promptmint.git
cd promptmint
python3 -m pip install -e .

Usage

promptmint -g "Fix this bug" -m debug
promptmint --goal "Review this PR" --mode review --output review-context.md
promptmint --goal "Explain this project" --mode explain
promptmint -e error.log -m debug -c

CLI Shortcuts

  • -g, --goal: task goal
  • -m, --mode: prompt mode
  • -e, --error: error log file
  • -i, --include: include glob, repeatable
  • -x, --exclude: exclude glob, repeatable
  • -o, --output: output Markdown file
  • -c, --copy: copy output to clipboard
  • -s, --max-file-bytes: skip files larger than this size

Modes

  • debug: root cause + smallest safe fix
  • review: bugs, security, performance, maintainability
  • explain: explain how the project works
  • refactor: safe refactor plan

What it includes

  • Project tree
  • Dependency/manifest files like package.json, pyproject.toml, composer.json, go.mod, pubspec.yaml
  • Git diff, if available
  • Text source files
  • Optional error log
  • Final instruction tailored to the selected mode

What it ignores by default

  • .git, node_modules, vendor, dist, build, virtual environments, caches
  • .env files
  • Binary files
  • Large files over 50KB by default

Examples

promptmint . --include "src/**/*.py" --goal "Find the bug"
promptmint . --exclude "tests/fixtures/**" --max-file-bytes 20000

Development

python3 -m unittest discover -s tests -v

Roadmap

  • Markdown context pack generator
  • Project tree + file scanner
  • Dependency manifest detection
  • Git diff inclusion
  • Debug/review/explain/refactor modes
  • Better .gitignore support
  • Token budget smart trimming
  • Interactive file picker
  • JSON output
  • MCP server integration

License

MIT

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

promptmint-0.1.0.tar.gz (8.4 kB view details)

Uploaded Source

Built Distribution

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

promptmint-0.1.0-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

Details for the file promptmint-0.1.0.tar.gz.

File metadata

  • Download URL: promptmint-0.1.0.tar.gz
  • Upload date:
  • Size: 8.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.2

File hashes

Hashes for promptmint-0.1.0.tar.gz
Algorithm Hash digest
SHA256 8d1cba7211184abaa568c846e7b00d69e56f45b830ecb49a647c4395ea0392eb
MD5 d1b6cc489adfc09c8c7b87b35de320a1
BLAKE2b-256 5d3e9b0936e9ad16065310b5c4ca30e4d3f0186bb9ef31655870c275acf70bec

See more details on using hashes here.

File details

Details for the file promptmint-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: promptmint-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 8.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.2

File hashes

Hashes for promptmint-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9e3fa287c6b1b9783fd323a167b8373e5a25a850a7477fb16f75cbd5cfa52d9e
MD5 5b011ef7b58ffa5b77d7b9612a1e6dfb
BLAKE2b-256 974b1d48deca06e4fd8d9028256c98a4d2258ebf2fbcc3245904a7ab4d538e4b

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