A tool to scan a Git repository and generate a comprehensive prompt for AI models, including file tree structure, file paths, and content.

• Creates a hierarchical file tree representation of a repository
• Includes file contents formatted for AI prompts
• Customizable file inclusion/exclusion via patterns
• Option to save output to a file or print to console
• Automatically respects local and global .gitignore files
• Cursor IDE integration with one command
• Automatically excludes .git directories
• Installable CLI tool

# From PyPI (recommended)
pip install codebase-ai-prompt-generator
# From source
git clone https://github.com/DengYiping/codebase-ai-prompt-generator.git
cd codebase-ai-prompt-generator
pip install -e .

After installation, you can use the codebase-prompt command directly from your terminal:

# Basic usage (scans current directory)
codebase-prompt
# Scan a specific repository
codebase-prompt /path/to/repository
# Exclude specific file patterns
codebase-prompt --exclude "*.log" "*.tmp" ".env"
# Include only specific file patterns
codebase-prompt --include "*.py" "*.js" "*.html"
# Write output to a file
codebase-prompt --output prompt.md
# Show version information
codebase-prompt --version
# Ignore .gitignore files (both local and global)
codebase-prompt --no-gitignore
# Output to Cursor IDE rules directory
codebase-prompt --cursor
# Combine options
codebase-prompt /path/to/repository --exclude "node_modules" "*.pyc" --include "*.py" "*.js" --output prompt.md

The tool automatically excludes certain files and directories to keep the output clean and relevant:

• .git directory and all its contents (always excluded)
• Files matching patterns in .gitignore files (unless --no-gitignore is used)
• Common build artifacts and cache directories (__pycache__, *.pyc, node_modules, etc.)

These exclusions help reduce noise and keep the generated prompt focused on the actual codebase content.

By default, the tool respects both:

• The repository's local .gitignore file
• The user's global gitignore file (found via git config --global --get core.excludesfile)

Files matching any pattern in these files will be excluded from the output. To disable this feature, use the --no-gitignore flag.

The --cursor flag automatically generates a prompt file at .cursor/rules/entire-codebase.mdc in your repository. This allows Cursor IDE to use your codebase as context when you're working with AI assistance.

To use:

1. Navigate to your repository
2. Run codebase-prompt --cursor
3. The prompt will be available to Cursor IDE

The --cursor flag overrides the --output flag if both are specified.

The generated prompt will have the following structure:

# Repository: repo-name
## File Tree Structure
📁 src/
📄 src/main.py
📄 src/utils.py
📁 tests/
📄 tests/test_main.py
📄 README.md
## File Contents
### src/main.py
```python
def main():
    print("Hello World")

def helper():
    return "Helper function"

...

## Use Cases
- Generate prompts for AI code assistants to understand your entire codebase
- Create documentation snapshots of your repository
- Share codebase context with AI models for better assistance
- Provide comprehensive context to LLMs for code-related questions
- Integrate with Cursor IDE for better AI-assisted coding
## Development
To set up the development environment:
```bash
# Clone the repository
git clone https://github.com/DengYiping/codebase-ai-prompt-generator.git
cd codebase-ai-prompt-generator
# Create and activate a virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
# Install in development mode
pip install -e .

This project is configured with GitHub Actions to automatically publish to PyPI when a new release is created:

1. Run the release preparation script to update the version:

   python scripts/prepare_release.py [major|minor|patch]

   This script will:

   • Update the version in codebase_prompt_gen/__init__.py
   • Create a git commit with the version change
   • Create a git tag for the new version

2. Push the changes and tag to GitHub:

   git push origin main && git push origin v0.x.y

3. Create a new GitHub release from the tag

   • Go to your repository on GitHub
   • Navigate to "Releases"
   • Click "Create a new release"
   • Select the tag you just pushed
   • Add release notes
   • Publish the release

4. The GitHub Actions workflow will automatically:

   • Build the package
   • Publish it to PyPI

To set up publishing, you'll need to:

1. Create an account on PyPI
2. Generate an API token in your PyPI account settings
3. Add the token as a secret in your GitHub repository settings:
   • Go to your repository → Settings → Secrets and variables → Actions
   • Add a new secret named PYPI_API_TOKEN with your PyPI token as the value

Contributions are welcome! Please feel free to submit a Pull Request.

This project is licensed under the MIT License - see the LICENSE file for details.