This README was written by ChatGPT, provided the collected code, generated by the Code Collector tool.
- Coming up with a cool name
- Initial prototype
- Windows support
- Advanced format collecting (e.g., pdf, pptx, etc.)
- Additional output formats (e.g., JSON, XML)
- System-wide configuration
- Directory specific configuration
- Ignore file
- Output size optimization (e.g., collapsing functions, code blocks, etc.)
- !!! Continuous code collection (watch mode) !!!
- Interactive CLI mode
- Packaging for Linux distributions
And more...
Code Collector is a Rust-based tool designed to collect and organize source code files from specified directories. It offers flexible configuration options to include or exclude specific paths or file formats.
The collected data is then written to a single .txt file, making it easy to supply to virtually any LLM or process in any other way.
- Flexible Path Configuration: Specify multiple directories to scan for code files.
- Format Filtering: Collect files based on specified formats/extensions.
- Ignore Paths: Exclude certain directories or files from the collection process.
- Output Options: Write the collected data to a specified output file.
-
Clone the Repository:
git clone https://github.com/iwannabeacookie/CodeCollectoR
-
Navigate to the Project Directory:
cd CodeCollectoR -
Install the Project:
cargo install --path . -
Configure PATH (if needed):
Ensure that the Cargo installation directory is in your system's PATH. The default installation directory is
$HOME/.cargo/bin.echo $PATH | grep ".cargo/bin"
If no output provided, proceed with the following steps.
Edit your shell profile file (e.g.,
~/.bashrc,~/.zshrc,~/.profile) and add the following line:export PATH="$HOME/.cargo/bin:$PATH"
Changes will take effect after you restart your terminal or run
source ~/.bashrc(or the corresponding file).
Code Collector can be configured via command-line arguments to specify paths, file formats, ignored directories, and the output file.
-p, --paths <PATHS>: Space-separated list of directories to scan.-f, --formats <FORMATS>: Space-separated list of file formats/extensions to include (e.g.,rs,py,js).-i, --ignore-paths <IGNORE_PATHS>: Space-separated list of paths to exclude from scanning.-o, --output <OUTPUT_FILE>: Path to the output file where collected data will be written.
./code_collector \
--paths ./src ./lib \
--formats rs py \
--ignore-paths ./src/tests ./lib/exclude \
--output collected_code.txtThis command will:
- Scan the
./srcand./libdirectories. - Include only
.rsand.pyfiles. - Ignore the
./src/testsand./lib/excludedirectories. - Write the collected data to
collected_code.txt.
Upon successful execution, the application will display a confirmation message:
Code collection completed. Output written to collected_code.txt
The collected_code.txt file will contain the structured data of the collected code files based on the specified configurations.
Contributions are welcome! If you have suggestions for improvements, bug fixes, or new features, please open an issue or submit a pull request.
-
Fork the Repository
-
Create a New Branch
git checkout -b feature/YourFeature
-
Commit Your Changes
git commit -m "Add some feature" -
Push to the Branch
git push origin feature/YourFeature
-
Open a Pull Request
Thank you for using Code Collector! If you have any questions or need assistance, feel free to reach out.