2 releases
0.1.1 | Sep 16, 2024 |
---|---|
0.1.0 | Sep 15, 2024 |
#141 in Command line utilities
380 downloads per month
22KB
495 lines
fcom (file_combiner)
fcom (short for file_combiner) is a versatile Rust CLI tool designed to process folders and files, combining their contents into a single output file. It offers a range of features for file manipulation and directory analysis.
Features
- Combine multiple files into a single output file
- Generate folder tree structures
- Create file lists
- Support for custom output formats (XML, Markdown, or custom templates)
- Option to add line numbers to file contents
- Ignore specific folders and filter by file extensions
Installation
Prerequisites
- Rust and Cargo (Install from https://www.rust-lang.org/tools/install)
Steps
-
Clone the repository:
git clone https://github.com/pabl-o-ce/fcom.git
-
Navigate to the project directory:
cd fcom
-
Build and install the binary:
cargo install --path .
This will install the fcom
binary in your Cargo bin directory.
Usage
fcom provides three main commands:
combine
: Combines multiple files into a single output filetree
: Generates a folder tree structurelist
: Creates a list of files in a folder
combine
fcom combine <FOLDER_PATH> [OPTIONS]
Options:
--output <FILE>
: Specify the output file (default: output.txt)--extensions <EXTENSIONS>...
: Specify file extensions to include--ignore <FOLDERS>...
: Specify folders to ignore (default: .git,node_modules,pycache)--add-line-numbers
: Add line numbers to file contents--mode <MODE>
: Specify the output mode (xml, markdown, or custom) (default: xml)--custom-output-template <FILE>
: Specify a custom output template file (required for custom mode)--custom-file-template <FILE>
: Specify a custom file template file (required for custom mode)
tree
fcom tree <FOLDER_PATH> [OPTIONS]
Options:
--output <FILE>
: Specify the output file (default: folder_tree.txt)--extensions <EXTENSIONS>...
: Specify file extensions to include--ignore <FOLDERS>...
: Specify folders to ignore (default: .git,node_modules,pycache)
list
fcom list <FOLDER_PATH> [OPTIONS]
Options:
--output <FILE>
: Specify the output file (default: file_list.txt)--extensions <EXTENSIONS>...
: Specify file extensions to include--ignore <FOLDERS>...
: Specify folders to ignore (default: .git,node_modules,pycache)
Examples
Combine files in XML format
fcom combine /path/to/your/folder --output combined_output.txt --mode xml
Generate a folder tree
fcom tree /path/to/your/folder --output folder_tree.txt
Create a file list
fcom list /path/to/your/folder --output file_list.txt
Combine files in Markdown format with line numbers
fcom combine /path/to/your/folder --output combined_output.md --mode markdown --add-line-numbers
Use custom templates
fcom combine /path/to/your/folder --output custom_output.txt --mode custom --custom-output-template /path/to/output_template.txt --custom-file-template /path/to/file_template.txt
Credits and Inspiration
This project was inspired by Maximilian-Winter's file_combiner. We appreciate their work and the ideas it provided for this implementation.
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Dependencies
~2–2.9MB
~50K SLoC