Skip to main content

Prepare code for AI chatbot assistance

Project description

aicodeprep (AI Code Prep)

aicodeprep is a command-line tool designed to simplify the process of sharing your project's code with AI chatbots. It recursively scans your project directory, concatenates all code files into a single text file, and copies the content to your clipboard for easy pasting into a LLM chat.

Purpose

The primary purpose of aicodeprep is to save time when you need to ask AI chatbots questions about your development project. Instead of manually copying and pasting multiple files, aicodeprep automates the process of gathering all your project's code into a single, easily shareable format.

Windows Installation

You can install aicodeprep directly from PyPI:

pip install aicodeprep

Linux Installation (Debian / Ubuntu / Mint)

pip install --user aicodeprep

sudo apt-get install xclip

echo 'export PATH="$PATH:$HOME/.local/bin"' >> ~/.bashrc

source ~/.bashrc

Linux Installation (Fedora)

pip install --user aicodeprep

sudo dnf install xclip

echo 'export PATH="$PATH:$HOME/.local/bin"' >> ~/.bashrc

source ~/.bashrc

xclip is needed in Linux for the clipboard functionality

Usage

After installation, you can run aicodeprep from any directory containing your project files and folders:

aicodeprep

This will create a file named fullcode.txt in the current directory and copy its contents to your clipboard.

example.png

Options

  • -n, --no-copy: Do NOT copy output to clipboard (default behavior is to copy)
  • -o FILENAME, --output FILENAME: Specify the output file name (default: fullcode.txt)

Example:

aicodeprep -n -o my_project_code.txt

This will create my_project_code.txt without copying to clipboard.

Configuration

You can customize aicodeprep's behavior by creating a aicodeprep_config.yaml file in your project directory. Here's an example:

code_extensions:

  • .py
  • .js
  • .html exclude_dirs:
  • node_modules
  • venv max_file_size: 500000 # in bytes

Contributions are welcome! Please feel free to submit a Pull Request. https://github.com/detroittommy879

Donations/Tip welcome! It helps motivate me to try and make cooler tools!

https://wuu73.org/hello.html

Tips: https://ko-fi.com/detroittommy879

Bitcoin: bc1qkuwhujaxhzk7e3g4f3vekpzjad2rwlh9usagy6

Litecoin: ltc1q3z327a3ea22mlhtawmdjxmwn69n65a32fek2s4

Monero: 46FzbFckBy9bbExzwAifMPBheYFb37k8ghGWSHqc6wE1BiEz6rQc2f665JmqUdtv1baRmuUEcDoJ2dpqY6Msa3uCKArszQZ

Cashapp: $lightweb73

License

This project is licensed under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aicodeprep-0.2.2.tar.gz (6.5 kB view details)

Uploaded Source

Built Distribution

aicodeprep-0.2.2-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

Details for the file aicodeprep-0.2.2.tar.gz.

File metadata

  • Download URL: aicodeprep-0.2.2.tar.gz
  • Upload date:
  • Size: 6.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.3

File hashes

Hashes for aicodeprep-0.2.2.tar.gz
Algorithm Hash digest
SHA256 e3eee0b153e39854a2512472194f4017a383f298752716002d8913585d11bbdc
MD5 d6da522f01dd3142a1d6f75e2a4a0a96
BLAKE2b-256 6d82561579b107a1298f4d36b86db4a4d3beecdcbe6daa8fda93b698b624b516

See more details on using hashes here.

File details

Details for the file aicodeprep-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: aicodeprep-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 7.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.3

File hashes

Hashes for aicodeprep-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a0483da4d8dc22d638dbbe5f2e31ae7e5187af767b414c23af88553d971ffafb
MD5 a05e27b6d1209a2196d84c9854aa4757
BLAKE2b-256 c3975882ac30aa4c0283d99a5149580266381fb236d10d67f1c25b593b7e3623

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page