Convert a directory structure and its contents into a single text file, including the tree output and file contents in markdown code blocks. It may be useful to chat with LLM about your code.
repo-to-text is an open-source project that converts the structure and contents of a directory (repository) into a single text file. By executing a simple command in the terminal, this tool generates a text representation of the directory, including the output of the tree command and the contents of each file, formatted for easy reading and sharing. This can be very useful for development and debugging with LLM.
The generated text file will include the directory structure and contents of each file. For a full example, see the example output for this repository.
The same text will appear in your clipboard. You can paste it into a dialog with the LLM and start communicating.
tree command.pip.To install repo-to-text via pip, run the following command:
pip install repo-to-text
To upgrade to the latest version, use the following command:
pip install --upgrade repo-to-text
After installation, you can use the repo-to-text command in your terminal. Navigate to the directory you want to convert and run:
repo-to-text
or
flatten
This will create a file named repo-to-text_YYYY-MM-DD-HH-MM-SS-UTC.txt in the current directory with the text representation of the repository. The contents of this file will also be copied to your clipboard for easy sharing.
You can customize the behavior of repo-to-text with the following options:
--output-dir <path>: Specify an output directory where the generated text file will be saved. For example:
repo-to-text --output-dir /path/to/output
This will save the file in the specified output directory instead of the current directory.
--create-settings or --init: Create a default .repo-to-text-settings.yaml file with predefined settings. This is useful if you want to start with a template settings file and customize it according to your needs. To create the default settings file, run the following command in your terminal:
repo-to-text --create-settings
or
repo-to-text --init
This will create a file named .repo-to-text-settings.yaml in the current directory. If the file already exists, an error will be raised to prevent overwriting.
--debug: Enable DEBUG logging. By default, repo-to-text runs with INFO logging level. To enable DEBUG logging, use the --debug flag:
repo-to-text --debug
or to save the debug log to a file:
repo-to-text --debug > debug_log.txt 2>&1
input_dir: Specify the directory to process. If not provided, the current directory (.) will be used. For example:
repo-to-text /path/to/input_dir
--stdout: Output the generated text to stdout instead of a file. This is useful for piping the output to another command or saving it to a file using shell redirection. For example:
repo-to-text --stdout > myfile.txt
This will write the output directly to myfile.txt instead of creating a timestamped file.
repo-to-text also supports configuration via a .repo-to-text-settings.yaml file. By default, the tool works without this file, but you can use it to customize what gets included in the final text file.
To create a settings file, add a file named .repo-to-text-settings.yaml at the root of your project with the following content:
# Syntax: gitignore rules
# Ignore files and directories for all sections from gitignore file
# Default: True
gitignore-import-and-ignore: True
# Ignore files and directories for tree
# and "Contents of ..." sections
ignore-tree-and-content:
- ".repo-to-text-settings.yaml"
- "examples/"
- "MANIFEST.in"
- "setup.py"
# Ignore files and directories for "Contents of ..." section
ignore-content:
- "README.md"
- "LICENSE"
- "tests/"
You can copy this file from the existing example in the project and adjust it to your needs. This file allows you to specify rules for what should be ignored when creating the text representation of the repository.
.gitignore for all sections.Using these settings, you can control which files and directories are included or excluded from the final text file.
Using Wildcard Patterns
*.ext: Matches any file ending with .ext in any directory.dir/*.ext: Matches files ending with .ext in the specified directory dir/.**/*.ext: Matches files ending with .ext in any subdirectory (recursive).If you want to include certain files that would otherwise be ignored, use the ! pattern:
ignore-tree-and-content:
- "*.txt"
- "!README.txt"
To ignore the generated text files, add the following lines to your .gitignore file:
repo-to-text_*.txt
To install repo-to-text locally for development, follow these steps:
Clone the repository:
git clone https://github.com/kirill-markin/repo-to-text
cd repo-to-text
Install the package with development dependencies:
pip install -e ".[dev]"
For development, additional packages are required:
To run the tests, use the following command:
pytest
To uninstall the package, run the following command from the directory where the repository is located:
pip uninstall repo-to-text
Contributions are welcome! If you have any suggestions or find a bug, please open an issue or submit a pull request.
This project is licensed under the MIT License - see the LICENSE file for details.
This project is maintained by Kirill Markin. For any inquiries or feedback, please contact markinkirill@gmail.com.
FAQs
Convert a directory structure and its contents into a single text file, including the tree output and file contents in markdown code blocks. It may be useful to chat with LLM about your code.
We found that repo-to-text demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.