repo2file-cli
| Crates.io | repo2file-cli |
| lib.rs | repo2file-cli |
| version | 0.1.2 |
| source | src |
| created_at | 2024-06-05 08:47:28.417306 |
| updated_at | 2024-07-25 10:37:54.321775 |
| description | A blazing fast CLI tool written in rust to turn a code repository into a single text file. |
| homepage | |
| repository | https://github.com/mbbrainz/repo2file-cli |
| max_upload_size | |
| id | 1262561 |
| size | 60,852 |
Maurits Bos (MbBrainz)
documentation
README
repo2file-cli
repo2file-cli is a command-line tool designed to consolidate a code repository into a single text file. This can be useful for archiving, analysis, or sharing purposes.
Installation
To install repo2file-cli, you need to have Rust installed. If you don't have Rust installed, you can get it from rustup.rs.
Once you have Rust, you can install the repo2file-cli using cargo:
cargo install repo2file-cli
Usage
To use repo2file-cli, you can run the following command:
repo2file-cli <input> [OPTIONS]
Arguments
<input>: The directory or Git URL of the repository you want to process.
Options
--ignore-files <FILES>: Comma-separated list of files to ignore.--ignore-dirs <DIRS>: Comma-separated list of directories to ignore.--include-files <FILES>: Comma-separated list of files to include exclusively (cannot be used with--ignore-filesor--ignore-dirs).--output <OUTPUT>: The output file. Defaults to a file named after the current directory.
Examples
Convert a local repository
repo2file-cli /path/to/repository --output output.txt
Convert a GitHub repository
repo2file-cli https://github.com/username/repo --output output.txt
Ignore specific files and directories
repo2file-cli /path/to/repository --ignore-files *.md,*.json --ignore-dirs node_modules,.git
Include only specific files
repo2file-cli /path/to/repository --include-files *.rs,*.toml
Contributing
We welcome contributions! Please follow these steps to contribute:
- Fork the repository.
- Create a new branch (
git checkout -b feature-branch). - Make your changes.
- Commit your changes (
git commit -am 'Add new feature'). - Push to the branch (
git push origin feature-branch). - Create a new Pull Request.
Development Setup
To set up your development environment, follow these steps:
- Clone the repository:
git clone https://github.com/yourusername/repo2file-cli.git - Change to the project directory:
cd repo2file-cli - Install the required extensions (if using VSCode):
Running Tests
You can run the tests using the following command:
cargo test
Build from source
you can install the binary from source while youre devin'
cargo install --path .
License
This project is licensed under the MIT License - see the LICENSE file for details.