Skip to main content

Flatten a project into a single LLM-friendly text dump

Project description

produm

produm is a tiny CLI tool that flattens any small project into a single, LLM-friendly document. Useful when you want to show an entire codebase to ChatGPT or other LLMs without manually copying files. This was created for Python projects, but it could be generalized for other projects.

Features

  • Generates a single .md dump with:
    • Directory tree
    • File list
    • All text-based file contents
  • Respects .gitignore (can be disabled)
  • Skips binary files automatically
  • Supports include/exclude rules
  • Optional line numbers for code review and debugging
  • Output name auto-generated unless specified
  • Optional PDF export via Pandoc
  • Clean command removes prior dump artifacts

Installation

uv add produm

or

pip install produm

Usage

Basic

produm

or

produm .

will clean old dumps, then create a new dump file from and in the current directory.

Subcommands

Dump only:

produm dump .

Clean only:

produm clean .

Dry-run cleaning:

produm clean . --dry-run

Advanced

Specify output:

produm dump . -o dump.md

Only include Python files:

produm dump . --include-ext .py

Skip the directory tree:

produm dump . --no-tree

Export PDF only:

produm dump . --pdf

PDF export requires pandoc and xelatex.

License

See LICENSE

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

produm-0.2.0.tar.gz (10.0 kB view details)

Uploaded Source

Built Distribution

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

produm-0.2.0-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

Details for the file produm-0.2.0.tar.gz.

File metadata

  • Download URL: produm-0.2.0.tar.gz
  • Upload date:
  • Size: 10.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.5

File hashes

Hashes for produm-0.2.0.tar.gz
Algorithm Hash digest
SHA256 4dcaed22673b105ec0a344a6f2134634c1e291ef7a0e9511d3e978d0595e76bb
MD5 d97e655478b3db1e4a11d46e1629f994
BLAKE2b-256 be5a0d2f9b8c82462f109889c602c8f3a7f66354ff60e8407f672aaed2a591a4

See more details on using hashes here.

File details

Details for the file produm-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: produm-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 12.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.5

File hashes

Hashes for produm-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a53e1c17c1c9e08b0f137effd8c3b48a035df1232ed5f2d2477d0a6320a762f3
MD5 553c6924215a03c0a9c34e7e14838339
BLAKE2b-256 bdef25e6f67438f3dabbc022d2f24da5ab0015b30453c1c7370323741ea4eed8

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