Skip to main content

Kitty Claw - AI-powered code rectification agent with a cute terminal mascot

Project description

Kitty Claw

🐱 AI-powered code rectification agent with a cute terminal mascot

Kitty Claw helps you identify and fix issues in your codebase. It combines AI-powered code analysis with an adorable terminal interface to make debugging more enjoyable.

Installation

Quick Install (Recommended)

Run one of these commands to install Kitty Claw:

For macOS/Linux:

curl -fsSL https://raw.githubusercontent.com/Vaibhav-Upadhyaya-codes/KittyClaw/deploy/install.sh | bash

For Windows:

powershell -ExecutionPolicy Bypass -Command "iwr -useb https://raw.githubusercontent.com/Vaibhav-Upadhyaya-codes/KittyClaw/deploy/install.ps1 | iex"

Manual Install

  1. Clone this repository
  2. Install dependencies:
pip install -e .
  1. Configure your API key:
# Set your OpenRouter API key
export OPENROUTER_API_KEY="your-api-key-here"
  1. Run Kitty Claw:
kittyclaw

Requirements

  • Python 3.8+
  • OpenRouter API Key (for AI functionality)
  • Optional: Ollama for local AI models

Getting Started

  1. Get your API key from OpenRouter.ai
  2. Run the installer - it will prompt for your API key
  3. Launch with kittyclaw - the terminal mascot will guide you

Features

  • 🐱 Cute terminal mascot with animations
  • 🤖 AI-powered code analysis
  • 🔄 Automatic code rectification
  • 🎨 Beautiful terminal interface
  • 💾 Configuration management

Configuration

Kitty Claw will create a .env file in ~/.kittyclaw with your settings:

OPENROUTER_API_KEY=your-api-key-here
OLLAMA_HOST=http://localhost:11434

Environment Variables

  • OPENROUTER_API_KEY: Your OpenRouter API key
  • OLLAMA_HOST: Ollama server URL (default: http://localhost:11434)

Usage

Launch Kitty Claw to see the interactive menu:

  1. Run full pipeline - Identifies and rectifies issues
  2. Rectification only - Fix specific issues
  3. Blink mascot - Just for fun!
  4. Show mascot - Display the static kitty
  5. Exit - Close Kitty Claw

Development

Installing Development Dependencies

pip install -e ".[dev]"

Running Tests

pytest

Contributing

Feel free to open issues and submit pull requests!

License

Apache-2.0

Troubleshooting

Installation Issues

  • Ensure Python 3.8+ is installed
  • Check if pip is available
  • Verify your API key format (should start with sk-)

Running Issues

  • Make sure your OpenRouter API key is set
  • If using Ollama, ensure it's running
  • Check the terminal compatibility (ANSI colors required)

Support

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

kittyclaw-0.2.2.tar.gz (30.8 kB view details)

Uploaded Source

Built Distribution

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

kittyclaw-0.2.2-py3-none-any.whl (31.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kittyclaw-0.2.2.tar.gz
  • Upload date:
  • Size: 30.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.4

File hashes

Hashes for kittyclaw-0.2.2.tar.gz
Algorithm Hash digest
SHA256 6fb5201a064ef335c69ff837148494d25cdabfe72b370971f02b5e1010400b70
MD5 195d9afde4b68b89831dcd5380247a89
BLAKE2b-256 5d2355eff5c6564350d006df348ba539eddfdb086869a952b31030adfea79d71

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kittyclaw-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 31.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.4

File hashes

Hashes for kittyclaw-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8905ae88dbc3f24a2b86073061c3efd1493473daa80c0c05b8e6dbea9a9a23c0
MD5 582b804155e81be4ea4d379336bc62f8
BLAKE2b-256 095b309ee64b4e7bc675694fd84b7da46fe865c9425c1c50bccb198bf4b1d14f

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