Getting Started

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 PyPI (Recommended)

# Create and activate virtual environment
python -m venv venv
source venv/bin/activate  # Linux/macOS
# or .\venv\Scripts\activate  # Windows

# Install OpenAkita (core)
pip install openakita

# Optional features
pip install "openakita[all]"      # install all optional features
# pip install "openakita[browser]"  # browser agent
# pip install "openakita[windows]"  # Windows desktop automation
# pip install "openakita[whisper]"  # voice recognition
# pip install "openakita[feishu]"   # Feishu (Lark)

# Run setup wizard
openakita init

Option 2: One-click install script (PyPI)

Linux/macOS:

curl -fsSL https://raw.githubusercontent.com/openakita/openakita/main/scripts/quickstart.sh | bash

Windows (PowerShell):

irm https://raw.githubusercontent.com/openakita/openakita/main/scripts/quickstart.ps1 | iex

To install extras / use a mirror, download and run with parameters (recommended):

curl -fsSL -o quickstart.sh https://raw.githubusercontent.com/openakita/openakita/main/scripts/quickstart.sh
bash quickstart.sh --extras all --index-url https://pypi.tuna.tsinghua.edu.cn/simple

irm https://raw.githubusercontent.com/openakita/openakita/main/scripts/quickstart.ps1 -OutFile quickstart.ps1
.\quickstart.ps1 -Extras all -IndexUrl https://pypi.tuna.tsinghua.edu.cn/simple

Option 3: Install from Source (Development)

git clone https://github.com/openakita/openakita.git
cd openakita
python -m venv venv
source venv/bin/activate  # Windows: .\venv\Scripts\activate
pip install -e ".[all,dev]"
openakita init

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:

1. Analyzes the task
2. Writes the code
3. Tests it
4. Reports the results

Common 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