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.0.tar.gz (4.7 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.0-py3-none-any.whl (5.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: buddy_ai_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 4.7 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.0.tar.gz
Algorithm Hash digest
SHA256 98936681a00136ca8c9ba52b038625ab42099bf37cc12df0755235cfaa35d696
MD5 42e658f19a7fd1e84cb0596854f2f7fc
BLAKE2b-256 93f92c6c1277500824145de437c81e48e5b39f644e422baba0e037213b46f8c5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: buddy_ai_cli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 5.4 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9d544ea54edc12ae165f4a7c749de577ce0f1564d691f84c54f362f900988c88
MD5 8ffeac34334955f0326ed9519967d499
BLAKE2b-256 b96f8e539cf2c76b8fb2ca7b528d2afd24d896140be3e5c8ecc506b05415d0cf

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