tools-only Getting Started
This guide will help you get OpenAkita up and running quickly.
Prerequisites
Before you begin, ensure you have:
- Python 3.11+ installed
- An Anthropic API key (get one here)
- Git for cloning the repository
Installation
Option 1: Install from Source (Recommended)
# Clone the repository
git clone https://github.com/openakita/openakita.git
cd openakita
# Create and activate virtual environment
python -m venv venv
# On Linux/macOS:
source venv/bin/activate
# On Windows:
venv\Scripts\activate
# Install the package
pip install -e .
Option 2: Install from PyPI (Coming Soon)
pip install openakita
Configuration
1. Create Environment File
cp .env.example .env
2. Add Your API Key
Edit .env and set your Anthropic API key:
ANTHROPIC_API_KEY=sk-your-api-key-here
3. Optional Settings
# Custom API endpoint (useful for proxies)
ANTHROPIC_BASE_URL=https://api.anthropic.com
# Model selection
DEFAULT_MODEL=claude-sonnet-4-20250514
# Agent behavior
MAX_ITERATIONS=100
AUTO_CONFIRM=false
Your First Run
Start the CLI
openakita
You should see:
╭─────────────────────────────────────────╮
│ OpenAkita v0.5.9 │
│ A Self-Evolving AI Agent │
╰─────────────────────────────────────────╯
You>
Try a Simple Task
You> Hello, what can you do?
OpenAkita will introduce itself and explain its capabilities.
Try a Complex Task
You> Create a Python script that calculates prime numbers up to 100
Watch as OpenAkita:
- Analyzes the task
- Writes the code
- Tests it
- Reports the results
Common Commands
| Command | Description |
|---|---|
openakita |
Start interactive mode |
openakita run "task" |
Execute a single task |
openakita status |
Show agent status |
openakita selfcheck |
Run self-diagnostics |
openakita --help |
Show all commands |
Next Steps
- Architecture Overview - Understand how OpenAkita works
- Configuration Guide - All configuration options
- Skills System - Create custom skills
- IM Channels - Set up Telegram, etc.
Troubleshooting
"API key not found"
Ensure your .env file exists and contains ANTHROPIC_API_KEY.
"Connection timeout"
Check your network connection. If in China, consider using a proxy:
ANTHROPIC_BASE_URL=https://your-proxy-url
"Python version error"
OpenAkita requires Python 3.11+. Check your version:
python --version
Need More Help?
- Check GitHub Issues
- Join GitHub Discussions