all-my-circuits
| Crates.io | all-my-circuits |
| lib.rs | all-my-circuits |
| version | 0.1.6 |
| source | src |
| created_at | 2024-10-27 17:44:30.243878 |
| updated_at | 2024-10-28 01:26:17.486499 |
| description | A command-line tool for concatenating and annotating files with Git metadata |
| homepage | https://github.com/oiwn/all-my-circuits |
| repository | https://github.com/oiwn/all-my-circuits |
| max_upload_size | |
| id | 1424820 |
| size | 48,392 |
oiwn (oiwn)
documentation
README
File Concatenator with Git Metadata
🚀 BLAZINGLY FAST 🚀 file concatenator built with 🦀 Rust 🦀! ⚡️ Combines your files into a single output while preserving Git history metadata with ZERO-COST ABSTRACTIONS and MEMORY SAFETY guarantees! ⚡️ Designed to create rich, contextual file dumps with Git metadata that serve as perfect context windows for Large Language Models — because your AI assistant deserves to know not just WHAT your code is, but WHEN and WHY it was written!
Features
- 🚶♂️ Recursively walks through directories
- 🎯 Filters files by extension
- 📝 Adds Git metadata headers (commit hash and timestamp)
- ⚙️ Configurable via TOML file
- 🛠️ Customizable delimiter for file sections
Installation
cargo install all-my-circuits
Quick Start
- Create a configuration file
.amc.toml(in current directory):
delimiter = "---"
extensions = ["rs", "ts", "py"]
- Run the tool:
# Scan current directory with default config
amc
# Scan specific directory with custom config
amc --dir ./src --config custom-config.toml
Output Format
The tool generates output in the following format:
---
File: src/main.rs
Last commit: 623a9e4b9dbdfa9367232ba67e7abe90245c2948
Last update: 1729838996
---
<file contents>
---
File: src/walk.rs
Last commit: 623a9e4b9dbdfa9367232ba67e7abe90245c2948
Last update: 1729838996
---
<file contents>
CLI Options
Usage: amc [OPTIONS]
Options:
-d, --dir <DIR> Directory to scan [default: .]
-c, --config <FILE> Config file path [default: .amc.toml]
-h, --help Print help
-V, --version Print version
Configuration
Create a .amc.toml file with the following options:
# String used to separate file sections
delimiter = "---"
# List of file extensions to process (without dots)
extensions = ["rs", "ts", "py", "md"]
Use Cases
- Generate documentation with context
- Create annotated source code compilations
- Prepare code for review with Git history
- Archive project snapshots with metadata
- Create meaningful diffs with context
Error Handling
The tool provides friendly error messages for common issues:
- Missing configuration file
- Invalid directory paths
- Git repository access problems
- File reading permissions
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.