Skip to main content

List relevant files with content in markdown format

Project description

listdump 📂💻→📝

PyPI – Version

listdump is a lightweight CLI tool that recursively (or non-recursively) lists relevant files in a directory and outputs their contents wrapped in Markdown-style code blocks (```), ready for documentation, debugging, or review.

by Tim Abdiukov


📦 Installation

pip install listdump

Run it from anywhere using:

listdump [arguments]

🚀 Usage

listdump [includes] [-x excludes] [-no-sub] [-out=filename] [-dir=path] [-no-gitignore] [-include-hidden]

🔧 Arguments

Argument Description
includes Extensions or glob patterns to include (py, txt, log_*_202*.log, etc.)
-x, --exclude Extensions or glob patterns to exclude
-no-sub Exclude subfolders
-out=FILE Output file name (default: output.md)
-dir=DIR Starting directory (default: current)
-no-gitignore Do not respect .gitignore rules
-include-hidden Include normally excluded files: .git, .gitignore, and listdump.md, and license files (LICENCE, LICENSE)
-h, --help Show help message

🧪 Examples

listdump txt py -x log tmp

Includes .txt and .py files, excludes .log and .tmp

listdump py -no-sub

Includes .py files only in the current directory

listdump py -no-gitignore -include-hidden

Includes .py files, even those ignored by .gitignore and including .git, .gitignore, listdump.md, and license files



Tim Abdiukov

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

listdump-0.1.6.tar.gz (12.5 kB view details)

Uploaded Source

Built Distribution

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

listdump-0.1.6-py3-none-any.whl (12.6 kB view details)

Uploaded Python 3

File details

Details for the file listdump-0.1.6.tar.gz.

File metadata

  • Download URL: listdump-0.1.6.tar.gz
  • Upload date:
  • Size: 12.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for listdump-0.1.6.tar.gz
Algorithm Hash digest
SHA256 2dfb93f257e3cd68955da2fe39437e274247730e6d576e2e81455b38e96ada55
MD5 eaa961aff9f63b38d4277f9eaf8c5a8c
BLAKE2b-256 f72c58c2e730410fe24e00f9c8964c4079b6bbdb7aeb5c2ac5d2024a757c31cb

See more details on using hashes here.

File details

Details for the file listdump-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: listdump-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 12.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for listdump-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 af2d6641fb81084a1825233b323fbc1ab92b9466e2a61a5a3f0a713b324d013d
MD5 5dd5b9aac524854e37c94b9e8f54bce0
BLAKE2b-256 130f32bbd264a764b5f8a0293812d115bb2cde1e6273495c950ddaca96dd3361

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