Metadata-Version: 2.4
Name: listdump
Version: 0.1.9
Summary: List relevant files with content in markdown format
Author-email: Tim Abdiukov <TAbdiukov@gmail.com>
License-Expression: Apache-2.0
Project-URL: Homepage, https://github.com/TAbdiukov/listdump
Project-URL: Source, https://github.com/TAbdiukov/listdump
Project-URL: Issues, https://github.com/TAbdiukov/listdump/issues
Project-URL: Documentation, https://github.com/TAbdiukov/listdump/blob/main/README.md
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENCE
Requires-Dist: pathspec
Dynamic: license-file

# listdump

[![GitHub](https://img.shields.io/badge/GitHub-TAbdiukov/listdump-black?logo=github)](https://github.com/TAbdiukov/listdump)
[![PyPI Version](https://img.shields.io/pypi/v/listdump.svg)](https://pypi.org/project/listdump) 
![License](https://img.shields.io/github/license/TAbdiukov/listdump)
[![Buy Me A Coffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-ffdd00?&logo=buy-me-a-coffee&logoColor=black)](https://buymeacoffee.com/tabdiukov)

**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

```bash
pip install listdump
```

Run it from anywhere using:

```bash
listdump [arguments]
```

---

## 🚀 Usage

```bash
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

```bash
listdump txt py -x log tmp
```

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

```bash
listdump py -no-sub
```

> Includes `.py` files only in the current directory

```bash
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***
