https://github.com/frizadiga/textify
Compile the Git repository into a single text file.
https://github.com/frizadiga/textify
cli git repository text
Last synced: about 2 months ago
JSON representation
Compile the Git repository into a single text file.
- Host: GitHub
- URL: https://github.com/frizadiga/textify
- Owner: frizadiga
- License: mit
- Created: 2025-05-24T17:47:14.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-16T13:19:08.000Z (about 1 year ago)
- Last Synced: 2025-06-16T14:39:28.482Z (about 1 year ago)
- Topics: cli, git, repository, text
- Language: Rust
- Homepage:
- Size: 14.6 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# textify
## Overview
**textify** is a command-line tool designed to convert a local Git repository into a text file that contains the contents of the files within the repository. This utility allows developers to easily view file content without manually browsing through the repository structure.
## Features
- Convert local Git repositories to a structured text file.
- Exclude large, binary, or specified files from the output.
- Customizable file size threshold to exclude large files.
- Progress tracking during the conversion process.
## Installation
To install the necessary dependencies, run:
```bash
cargo build --release
```
To install the tool globally, use:
```bash
cargo install --path .
```
## Usage
You can run the application from the command line as follows:
```bash
textify -- [OPTIONS]
```
### Options
- `--path `: Path to the repository (defaults to the current directory).
- `--output `: Specify the output file path.
- `--threshold `: Set the file size threshold in MB (default is 0.1 MB).
- `--include-all`: Include all files regardless of size or type.
- By default, `textify` excludes files matched by `.gitignore`.
- `--no-respect-gitignore`: Disable `.gitignore` filtering and include those files.
- Hidden files (like `.env.example`) are included by default unless excluded by ignore rules.
- `--debug`: Enable debug mode with verbose logging.
### Example
```bash
cargo run -- --path /path/to/repo --output output.txt --threshold 1.0
```
## Contributing
Contributions are welcome! Please feel free to submit a pull request or raise an issue.