https://github.com/tawandakembo/code-collator

https://github.com/tawandakembo/code-collator

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/tawandakembo/code-collator
• Owner: tawandakembo
• License: other
• Created: 2024-07-26T15:26:53.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-10-09T18:34:32.000Z (3 months ago)
• Last Synced: 2024-10-29T14:28:41.897Z (2 months ago)
• Language: Python
• Size: 279 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-ai-devtools - code-collator - coding assistance from the Claude/ChatGPT web interface rather than via the API. (Shell assistants)
• awesome-ai-coding - code-collator

README

        
# Code Collator

Code Collator is a powerful CLI tool designed to streamline your code review and documentation process by collating your entire codebase into a single, organised Markdown file. This is particularly useful for sharing with AI tools like ChatGPT or Claude for analysis, troubleshooting, or documentation.

## Use Case

Have you ever needed to provide a comprehensive overview of your codebase for a code review, AI analysis, or detailed documentation? Code Collator simplifies this task by aggregating all your code files into a single Markdown file. This makes it easy to:

- Share your code with AI tools like ChatGPT or Claude for intelligent analysis.

- Generate a unified document for code reviews or team collaboration.

- Create comprehensive documentation for your projects with minimal effort.

## Features

- **Full Codebase Collation**: Collates all files in the specified directory and subdirectories into one Markdown file.

- **.gitignore Support**: Automatically ignores files specified in the `.gitignore` file if one exists.

- **Customizable Output**: Outputs a single Markdown file named `collated-code.md` by default, with options to specify the path to the codebase directory and output file name.

- **Binary File Inclusion**: Includes binary files such as images in the output with a note about their file type.

- **Comment Exclusion Option**: Allows users to exclude comments and docstrings from the collated code.

- **Help Command**: Provides a help command to display usage instructions.

## Demo Video

[![Watch the demo video]([https://img.youtube.com/vi/e8Ep_NOi_xU/0.jpg](https://i.ytimg.com/vi/e8Ep_NOi_xU/maxresdefault.jpg))](https://youtu.be/e8Ep_NOi_xU)

*Click the image above to watch a hands-on demo of how Code Collator works.*

## Installation

You can easily install Code Collator using pip:

```sh

pip install code-collator