listdump 0.2.0

List relevant files with content in markdown format

listdump

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, -ex, --ex	Extensions or glob patterns to exclude
-no-sub	Exclude subfolders
-out=FILE	Output file name (default: listdump.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