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
.txtand.pyfiles, excludes.logand.tmp
listdump py -no-sub
Includes
.pyfiles only in the current directory
listdump py -no-gitignore -include-hidden
Includes
.pyfiles, even those ignored by.gitignoreand including.git,.gitignore,listdump.md, and license files
Tim Abdiukov
Release files for listdump 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| listdump-0.2.0.tar.gz | 8.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| listdump-0.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 17.5 kB
Release files / listdump-0.2.0.tar.gz
| Download URL | listdump-0.2.0.tar.gz |
|---|---|
| Size | 8.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
27ac7fc49ce2a579b9f68e95b1aabbe03c5b9482a3d65169e733ac90cbb1c6e6
|
|
BLAKE2b-256 checksum How to use checksums |
682939947da88f7bb0849e7da0155d3023dd8733807f029f971482fc9ec96b06
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.0
|
Release files / listdump-0.2.0-py3-none-any.whl
| Download URL | listdump-0.2.0-py3-none-any.whl |
|---|---|
| Size | 9.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fdd9dfda0f2d988acae8500e20c8c3ef73877b3fc01b00fd56f195dbc0c2363f
|
|
BLAKE2b-256 checksum How to use checksums |
2352127c0bf70bb158bfade58a2c576ada54be82532e85f4fd4d2e1a53f65afc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.0
|