CLI tool for converting codebases into single Markdown documents
Top 70.1% on sourcepulse
CodeWeaver is a command-line tool designed to consolidate entire codebases into a single, navigable Markdown document. It's ideal for developers, researchers, and anyone needing to share, document, or process codebases with AI/ML tools, offering a unified and readable format.
How It Works
The tool recursively scans a specified directory, building a tree-like representation of the project structure. It then embeds the content of each file within Markdown code blocks, intelligently using file extensions to apply syntax highlighting. This approach provides a comprehensive, self-contained snapshot of a codebase, simplifying sharing and analysis.
Quick Start & Requirements
go install github.com/tesserato/CodeWeaver@latest
(requires Go 1.18+).codeweaver [options]
Highlighted Details
Maintenance & Community
Contributions are welcome via issues or pull requests on GitHub.
Licensing & Compatibility
Released under the MIT License, permitting commercial use and integration with closed-source projects.
Limitations & Caveats
The tool relies on regular expressions for filtering, which may require careful crafting for complex exclusion/inclusion rules. No specific performance benchmarks or resource requirements are detailed beyond the Go dependency.
2 months ago
Inactive