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.3.1.tar.gz (32.3 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.3.1-py3-none-any.whl (33.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for kittyclaw-0.3.1.tar.gz
Algorithm Hash digest
SHA256 ec9c1723e8dd4f487af1fd1e55e6f77a88dacfea5954eca99797518a1c9911f0
MD5 de69991e5d5223faae6cc2395c604a2c
BLAKE2b-256 795c4e2f74a0825adcdeb4b159967d887fc31ac97cb1dcda35cbc76a682b9bd5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kittyclaw-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 33.0 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.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 97eb7ccaa0422be7c597d5289f2d4759280edc4fdf78fa0788ee289592a597a0
MD5 bfe8faff1ae2e0c279870378936aeeaa
BLAKE2b-256 cdf0f3c8320792e81c07c627033ae9969727ac93462a4662e1fe098da01f94c5

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