https://github.com/starc007/file-combiner
A CLI tool that merges multiple files into one, preserving directory structure, ideal for creating context files for AI training or analysis.
https://github.com/starc007/file-combiner
ai file-combiner rust
Last synced: 6 months ago
JSON representation
A CLI tool that merges multiple files into one, preserving directory structure, ideal for creating context files for AI training or analysis.
- Host: GitHub
- URL: https://github.com/starc007/file-combiner
- Owner: starc007
- Created: 2024-10-18T17:40:06.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-10-20T09:36:57.000Z (12 months ago)
- Last Synced: 2024-10-20T14:08:30.768Z (12 months ago)
- Topics: ai, file-combiner, rust
- Language: Rust
- Homepage:
- Size: 515 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# @saura3h/file-combiner
File Combiner: A CLI tool that merges multiple files into one, preserving directory structure, ideal for creating context files for AI training or analysis.
## Installation
You can install File Combiner globally using npm:
```bash
npm install -g @saura3h/file-combiner
```
This will make the `file-combiner` command available in your terminal.
## Usage
After installation, you can use the File Combiner tool as follows:
```bash
file-combiner --directory --output-file --extensions
```
### Options:
- `--directory` or `-d`: The path to the directory containing the files you want to combine.
- `--output-file` or `-o`: The name of the file where the combined content will be saved.
- `--extensions` or `-e`: (Optional) File extensions to include, separated by spaces. If not specified, all files will be included.
### Example:
To combine all TypeScript and JavaScript files in the current directory into a file named `combined_code.txt`:
```bash
file-combiner --directory ./ --output-file combined_code.txt --extensions ts js
```
## Features
- Combines multiple files into a single file
- Preserves directory structure in the output
- Option to filter files by extension
- Works on macOS
- Coming soon on Linux and Windows
## Excluded Directories
By default, the following directories are excluded from processing:
- node_modules
- .git
- dist
- build
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
This project is licensed under the MIT License.
## Support
If you encounter any issues or have questions, please file an issue on the GitHub repository.
## Author
Created by [Saurabh](https://x.com/saurra3h)
---
Remember to star this repo if you find it useful! ⭐️