copcon 0.2.1

No project description provided

Copcon 🐎

Copcon (Copy Context) is a CLI tool designed to rapidly capture and summarize code context for use in large language model (LLM) based chatbots like Claude and ChatGPT.

Just point the copcon command at a directory, and all the LLM needs to know about your code is copied to your clipboard, ready to fire into ChatGPT with CTRL+V 🐎

Why Copcon?

• 🚀 Speed Up Your Workflow: No more manual explanations of your project structure.
• 🎯 Get More Accurate AI Responses: Provide complete context in seconds.
• 🧠 Enhance AI Understanding: Help AI understand your specific codebase instantly.

Features

• Generate a directory tree structure
• Capture file contents
• Customizable depth for directory traversal
• Ability to exclude hidden files and directories
• Option to ignore specific directories and files
• Copies the generated report to the clipboard

Quick Start

1. Install: pip install copcon
2. Run: copcon /path/to/your/project
3. Paste the result into your AI chat

Usage

After installation, you can use the copcon command:

copcon /path/to/your/directory

Options:

• --depth INTEGER: Depth of directory tree to display (-1 for unlimited)
• --exclude-hidden / --no-exclude-hidden: Exclude hidden files and directories (default: True)
• --ignore-dirs TEXT: Additional directories to ignore (can be used multiple times)
• --ignore-files TEXT: Additional files to ignore (can be used multiple times)

For help, use:

copcon --help

By default, Copcon ignores the following directories: __pycache__, .venv, node_modules, .git, .idea, .vscode, build, dist, target

And the following files: poetry.lock, package-lock.json, Cargo.lock, .DS_Store, yarn.lock

You can add more directories or files to ignore using the --ignore-dirs and --ignore-files options:

copcon /path/to/your/directory --ignore-dirs my_ignore_dir --ignore-files my_ignore_file.txt

Note

This tool is designed for macOS and Windows.

Development

To set up the development environment:

1. Ensure you have Python 3.11+ and Poetry installed
2. Clone the repository
3. Run poetry install to install dependencies

Contributing

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

License

This project is licensed under the MIT License.