Repository files navigation

Here's a secret about AI coding assistants: they're only as good as the context you give them! Forget chasing perfect prompts or waiting for the next big model - what truly transforms an AI assistant into a reliable coding partner is crystal-clear context about your project.

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

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

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.

# Installpip install contextor# Run (will include all files)contextor --directory ./my_project# Or specify key files onlycontextor --files main.py config.yaml

• 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

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

Need more control? We've got you covered:

# Include files listed in a text filecontextor --files-list important_files.txt# Custom exclude patternscontextor --exclude-file exclude_patterns.txt# Ignore .gitignorecontextor --no-gitignore# Include essential context and supplementary infocontextor --prefix-file project_overview.txt --appendix-file api_docs.txt# Add schemas and deployment guidescontextor --prefix-file schemas.txt --appendix-file deployment.txt

src/main.pyconfig/settings.yamlREADME.md

*.pyc__pycache__/.env*.log

Contextor looks out for you:

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

# From PyPI (recommended)pip install contextor# From sourcegit clone https://github.com/ergut/contextorpip install -r requirements.txt

We love contributions! Check outREADME.test.md for:

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

MIT License - SeeLICENSE file

• 🐛Report issues
• 💡Feature requests
• 📖Documentation

Salih Ergüt

Current version: 1.0.3

SeeCHANGELOG.md for version history and updates.