dir2context

dir2context is a CLI tool that generates clean, consolidated text context files from source directories. Ideal for feeding source code or structured content into Large Language Models (LLMs) like GPT, Claude, or Mistral.

📦 Installation

Global installation

npm install -g dir2context

Without installing (via npx)

npx dir2context ./src --output context.txt

🚀 Usage

dir2context [directory] [options]

Run with all defaults (include all files and directories from current folder)

dir2context

Options

| Option | Description | |--------------------------|-----------------------------------------------------------------------------------------------| | --output <file> | Output file name. Defaults to dir2context_<timestamp>.txt. | | --ext <list> | Comma-separated list of file extensions to include (e.g. .java,.ts). | | --exclude-dirs <list> | Comma-separated list of directory names to exclude. | | --exclude-files <list> | Comma-separated list of specific file names to exclude. | | --ignore-hidden | Skip hidden files and directories (those starting with .). | | --chunk-size <n> | Maximum number of characters per output file. Ensures files are kept whole (not split). | | --json | Print summary in JSON format. If used with --output, also creates <output>.stats.json. | | --quiet | Suppress normal output (only errors will be printed). | | --help, -h | Show help message. | | --version, -v | Show version number. |

💡 Examples

# Basic usage (defaults to .java files)
dir2context ./src

# Custom output file
dir2context ./project --output context.txt

# Include both Java and Kotlin files
dir2context . --ext .java,.kt

# Exclude test directories and hidden files
dir2context . --exclude-dirs test --ignore-hidden

# Exclude specific files by name
dir2context . --exclude-files build.gradle,MainTest.java

📁 Output format

Each file is included in the output like this:

File: MyClass.java
Path: /absolute/path/to/MyClass.java

<contents of file>

🧠 Use cases

Preparing context for prompting LLMs with multi-file source code.

Code analysis pipelines.

Documentation extraction.

Preprocessing for embedding or chunking tools.

🪪 License

MIT License

Copyright (c) 2025 Enrique Ismael Mendoza Robaina

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.