CodeContextor 🚀

Note: This package replaces the deprecated codecontextor package.

Ever needed to explain your codebase to ChatGPT or Claude? CodeContextor creates a perfect snapshot of your project in seconds:

# That's it! Just run:
codecontextor --directory ./my_project

What You Get ✨

my_project/
├── src/
│   └── main.py     # LLMs can request this file if needed!
└── config/
    └── settings.yaml

# Key files are included below the tree...

Just paste this into your AI chat and start coding! The AI can see your project structure and request any file it needs.

Quick Start 🏃‍♂️

# Install
pip install codecontextor

# Run (will include all files)
codecontextor --directory ./my_project

# Or specify key files only
codecontextor --files main.py config.yaml

Why CodeContextor? 🎯

• Simple: One command to create perfect context for AI conversations
• Smart: Respects .gitignore, handles large files, includes safety checks
• Flexible: Include specific files or let the AI see everything
• Safe: Warns you about size and skips files >10MB

Features in Detail 🛠️

• 📁 Complete project tree generation
• 📄 Automatic or selective file inclusion
• 🔒 .gitignore pattern support
• ⚡ Large file protection
• 🎮 Custom file exclusions
• 📊 Size warnings and confirmations

Advanced Usage 🔧

Need more control? We've got you covered:

# Include files listed in a text file
codecontextor --files-list important_files.txt

# Custom exclude patterns
codecontextor --exclude-file exclude_patterns.txt

# Ignore .gitignore
codecontextor --no-gitignore

# Include essential context and supplementary info
codecontextor --prefix-file project_overview.txt --appendix-file api_docs.txt

# Add schemas and deployment guides
codecontextor --prefix-file schemas.txt --appendix-file deployment.txt

Command Line Options 🎛️

Examples 📚

Include specific files (files-list.txt):

src/main.py
config/settings.yaml
README.md

Exclude patterns (exclude-patterns.txt):

*.pyc
__pycache__/
.env
*.log

Safety First 🛡️

CodeContextor looks out for you:

• Calculates total file size
• Shows warning for large directories
• Asks for confirmation
• Skips files >10MB
• Respects .gitignore by default

Installation Options 📦

# From PyPI (recommended)
pip install codecontextor

# From source
git clone https://github.com/ergut/codecontextor
pip install -r requirements.txt

Contributing 🤝

We love contributions! Check out README.test.md for:

• Running tests
• Test coverage details
• Adding new features
• Contributing guidelines

License 📜

MIT License - See LICENSE file

Support 💬

• 🐛 Report issues
• 💡 Feature requests
• 📖 Documentation

Author ✍️

Salih Ergüt

Version 📋

Current version: 1.0.3

See CHANGELOG.md for version history and updates.