merger-cli 1.0.3

Merger is a tool that scans a directory, filters files using customizable patterns, and merges readable content into a single output file.

Merger CLI

Merger is a command-line utility for developers that scans a directory, filters files using customizable ignore patterns, and merges all readable content into a single structured output file. It supports custom file readers and validators, making it easily extendable for formats such as .ipynb, .pdf, or any specific format.

---

Summary

1. Core Features
2. Dependencies
3. Installation with PyPI
4. Build and Install Locally
5. Usage
6. Custom Readers
7. CLI Options
8. License

---

Core Features

• Recursive merge of all readable text files under a root directory.
• Glob-based ignore patterns using .gitignore-style syntax.
• Automatic encoding detection.
• Custom file readers and validators for non-text formats.
• CLI support for installation, removal, and listing of custom readers.
• Human-readable merged output, including a directory tree header and file delimiters.

---

Dependencies

Component	Version / Type	Notes
Python	≥ 3.8	Required

All dependencies are listed in requirements.txt.

---

Install directly from PyPI

pip install merger-cli

Clone and build locally

1. Clone the repository

git clone https://github.com/diogotoporcov/merger-cli.git
cd merger-cli

git clone https://github.com/diogotoporcov/merger-cli.git
cd merger-cli

2. Create and activate a virtual environment

Linux / macOS

python -m venv .venv
source .venv/bin/activate

Windows (PowerShell)

python -m venv .venv
.venv\Scripts\Activate.ps1

3. Install dependencies

pip install -r requirements.txt

4. Install as CLI tool

pip install .

This registers the merger command globally.

---

Usage

Basic merge

merger ./src ./merged.txt

Custom ignore patterns

merger "C:\Users\USER\Desktop\project" "C:\Users\USER\Desktop\project\output.txt" --ignore "*.log" "__pycache__" "*.tmp"

Custom ignore file

merger . ./output.txt -p ./merger.ignore

Include empty files

merger ./data ./output.txt --empty

Verbose output

merger ./src ./merged.txt --log-level DEBUG

---

Custom Readers

You can extend Merger to handle new file formats.

Installing a custom reader

merger --install .ipynb path/to/ipynb.py

Where ipynb.py must define:

• validator: Callable[[Path], bool]
  

• reader: Callable[[Path], str]
  

To uninstall:

merger --uninstall .ipynb

List installed readers:

merger --list-installed

An example .ipynb reader can be found in examples/custom_readers/ipynb.py.

---

CLI Options

Option	Description
--ignore	List of glob-style ignore patterns.
-f, --ignore-file	Path to file containing ignore patterns (Default: <input_dir>/merger.ignore.
-i, --install	Install a custom reader for an extension.
-u, --uninstall	Remove a custom reader (* removes all).
--list-installed	Show installed readers.
-l, --log-level	Set logging verbosity (DEBUG, INFO, etc.).
--empty	Include empty files in merged output.
--prefix / --suffix	Customize file delimiters in output.
--overrides	Load override reader definitions from a Python module.
--no-tree	Do not include the generated directory tree in the output file.

---

License

This project is licensed under the MIT License — see LICENSE for details.