Skip to content

Latest commit

 

History

History
65 lines (42 loc) · 1.73 KB

README.md

File metadata and controls

65 lines (42 loc) · 1.73 KB
Raw

repo2txt

repo2txt is a Python package that clones a GitHub repository, generates a text file containing the repository's directory structure and the contents of all its files, and handles cleanup.

Installation

You can install repo2txt using pip:

pip install git+https://github.com/blaisewf/repo2txt.git

Alternatively, you can clone the repository and install it locally:

git clone https://github.com/blaisewf/repo2txt.git
cd repo2txt
pip install .

Usage

Once installed, you can use the CLI command repo2txt to process a GitHub repository. Here’s the basic syntax:

repo2txt --repo-url <repository_url> --output-file <output_file_path> --branch <branch_name> --config <config_file_path> --local-path <local_path>

Example

From GitHub:

repo2txt --repo-url https://github.com/example/repository.git --output-file output.txt --branch develop --config repo2txt/configs/config.json

Using a local folder:

repo2txt --local-path downloads/my-project --output-file output.txt  --config repo2txt/configs/config.json

This command will:

  1. Clone the repository from https://github.com/example/repository.git.
  2. Generate a text file output.txt containing the directory structure and contents of all files in the repository.
  3. Clean up the cloned repository directory.

Configuration

In the config file you can specify which files you want to ignore when generating the text file. The config file should be a JSON file with the following structure:

{
  "ignore": ["*.md", "*.log", "node_modules", ".git"]
}

License

This project is licensed under the MIT License. See the LICENSE file for details.

References