code2prompt

README

Code2Prompt

Code2Prompt is a powerful command-line tool that converts your entire codebase into a comprehensive prompt for Large Language Models (LLMs). It's designed to provide extensive context about your project, making it easier for LLMs to understand and assist with your codebase.

Features

• Codebase Traversal: Automatically walks through your project directory, respecting .gitignore rules.
• Source Tree Generation: Creates a hierarchical representation of your project structure.
• Prompt Templating: Customizable prompt generation using Handlebars templates.
• Token Counting: Calculates the token count of the generated prompt for compatibility with various LLM token limits.
• Multiple Output Formats: Supports plain text and JSON output.
• Flexible File Filtering: Exclude additional files using glob patterns.

Installation

Prerequisites

• Go 1.22 or later

Building from Source

1. Clone the repository:

   git clone https://github.com/holistic-engineering/code2prompt.git
   cd code2prompt
   

2. Build the project:

   make build
   

This will create a code2prompt binary in your current directory.

Usage

Basic usage:

code2prompt [flags] <path>

Flags

• -e, --exclude: File patterns to exclude (comma-separated)
• -t, --template: Path to custom template file
• -o, --output: Output file path
• --tokens: Count tokens in the generated prompt
• --json: Output as JSON
• --encoding: Tokenizer encoding to use (default "cl100k_base")

Examples

1. Generate a prompt for a project:

   code2prompt /path/to/your/project
   

2. Generate a prompt, excluding certain file types:

   code2prompt --exclude "*.md,*.txt" /path/to/your/project
   

3. Use a custom template and save the output:

   code2prompt -t custom_template.hbs -o output.md /path/to/your/project
   

4. Generate JSON output with token count:

   code2prompt --json --tokens /path/to/your/project
   

Custom Templates

You can create custom templates for the prompt using the HandlebarsJS templating engine. The following list shows all available variables and helper functions.

• sourceTree: tree representation of the project structure
• files: list of all filtered project files
• this.Path: the individual file's path
• this.Content: the individual file's content
• getFileExtension: gets the file extension for a given a file path

Default Temlate

# Project Structure
{{sourceTree}}

# Files
{{#each files}}
## {{this.Path}}
'''{{getFileExtension this.Path}}
{{this.Content}}
'''

{{/each}}

Development

Prerequisites

• Go 1.22 or later
• Make

Setup

1. Clone the repository:

   git clone https://github.com/holistic-engineering/code2prompt.git
   cd code2prompt
   

2. Install dependencies:

   make deps
   

Building

To build the project:

make build

Clean Up

To clean up built binaries:

make clean

Contributing

Contributions to Code2Prompt 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.

Acknowledgments

• Cobra for CLI interface
• Viper for configuration management
• Raymond for Handlebars templating
• TikToken for token counting