Skip to main content

Your AI Coding Assistant CLI

Project description

Buddy - AI Coding Assistant

Buddy is a powerful CLI tool that leverages Groq's LLMs to help you write, explain, and refactor code directly from your terminal.

Installation

pip install buddy-ai-cli

Or install from source:

git clone https://github.com/yeabwang/buddy.git
cd buddy
pip install .

Configuration

1. Set up API Key

Buddy uses Groq. You need to set your API key first.

buddy config --key <YOUR_GROQ_API_KEY>

2. Health Check & Dependencies

Run buddy config without arguments to check your API key status and install dependencies from a requirements.txt if present in your current directory.

buddy config

Usage

Generate Code

Ask a question in a text file and get the code output.

# Create a question file
echo "Write a Python script to scrape a website" > question.txt

# Generate code
buddy code question.txt -a scraper.py

Explain Code

Get a clear explanation of what a code file does.

buddy explain complex_script.py

Refactor Code

Refactor code to be cleaner and more efficient.

# Print refactored code to stdout
buddy refactor legacy_code.py

# Save refactored code to a file
buddy refactor legacy_code.py -o clean_code.py

Options

  • -m, --model: Specify the LLM model to use (default: openai/gpt-oss-20b).
    buddy code question.txt -a answer.py -m llama3-70b-8192
    

License

MIT

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

buddy_ai_cli-0.1.1.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

buddy_ai_cli-0.1.1-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

Details for the file buddy_ai_cli-0.1.1.tar.gz.

File metadata

  • Download URL: buddy_ai_cli-0.1.1.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for buddy_ai_cli-0.1.1.tar.gz
Algorithm Hash digest
SHA256 09aa83a6baa754111b2cff0a21ce91d22373ec4e951de968d268bae304c70a72
MD5 0af2fa230fc7f7609598899a7031c6e4
BLAKE2b-256 907c8e724c9af678d1dead69f377806b4768bf8310a13a153608fad5ebe64fb3

See more details on using hashes here.

File details

Details for the file buddy_ai_cli-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: buddy_ai_cli-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 5.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for buddy_ai_cli-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 18a5526b3f95936b7e258124db60e706ffa29e5df473510a1ffc1f1d177cf97b
MD5 1221fc602361cc6f45c41fba04716f7f
BLAKE2b-256 c3a34618a95141026f8f1e6efe8bce640d1c56917510661d443b9a413e71e16f

See more details on using hashes here.

Supported by

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