Skip to main content

Dump project files into a single markdown file with folder structure

Project description

projdump2md

A simple CLI tool to dump all project files into a single markdown file with folder structure visualization specially for AI/LLM use.

Installation

From PyPI

pip install projdump2md

Usage

Commandline arguments

File Extension Filters

Option Description Example
-i, --include File extensions to include -i py,js,html
-e, --exclude File extensions to exclude -e log,tmp,bak
--no-default-excludes Disable default file exclusions --no-default-excludes

Default excluded extensions: pyc, o, bin, hex, md, elf

Folder Filters

Option Description Example
-I, --include-folders Folders to include -I src,lib
-E, --exclude-folders Folders to exclude -E tests,docs
--no-default-folder-excludes Disable default folder exclusions --no-default-folder-excludes

Default excluded folders: __pycache__, node_modules, .git, .svn, .hg, venv, env, .venv, dist, build, .idea, .vscode

General Options

Option Description Default
-f, --folder Folder path to scan . (current directory)
-o, --output Output file name project_dump.md
--version Show version -
-h, --help Show help message -

Examples

Dump all Python files from current directory

projdump2md -i py

Dump multiple file types

projdump2md -i py,js,html,css

Dump Python and JavaScript, exclude *.log files

projdump2md -i py,js -e log

Specify a different folder

projdump2md -i cpp,h -f /path/to/project

Custom output filename

projdump2md -i py -o my_project_dump.md

Dump all files (no extension filter)

projdump2md -f .

Folder Filtering

Only include src and lib folders

projdump2md -I src,lib

Exclude test and documentation folders

projdump2md -E tests,docs,examples

Only Python files from src folder

projdump2md -i py -I src

Include node_modules (override default exclusion)

projdump2md --no-default-folder-excludes -I node_modules

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

projdump2md-0.1.0.tar.gz (6.3 kB view details)

Uploaded Source

Built Distribution

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

projdump2md-0.1.0-py3-none-any.whl (7.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: projdump2md-0.1.0.tar.gz
  • Upload date:
  • Size: 6.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for projdump2md-0.1.0.tar.gz
Algorithm Hash digest
SHA256 ce694d8f7ec9ad9c81512521b7e73e8d6057ab558c30e568c2c36a920fd66425
MD5 d71799026a02519453e178fd17b5d8c5
BLAKE2b-256 b1ef06efb7708a492367cfed95e4803ce8469e419e808ee3b2372273d3afa930

See more details on using hashes here.

File details

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

File metadata

  • Download URL: projdump2md-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for projdump2md-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 09101cb359c17d1648edaadb1fc88e88d0703dbae9407f2c3c5ac9c6a19ae001
MD5 4f411b2101c0455d6684a6b00366dd5b
BLAKE2b-256 f79db9f721a041c3861d5af4dcd6e1423040d13d12e3e7f2c09ecf44e50c480a

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