Annona โ installation guide¶
๐ Quick Install (Recommended)¶
One-Line Installation¶
Or with wget:
What it does:¶
- โ Checks system requirements (Python 3.10+, Git)
- โ Clones the repository
- โ Creates virtual environment
- โ Installs dependencies
- โ
Creates
akaioncommand in PATH - โ Sets up shell integration
- โ Creates systemd/launchd service (optional)
๐ฆ Manual Installation¶
Prerequisites¶
- Python 3.10 or higher
- Git
- pip
Step 1: Clone Repository¶
Step 2: Install¶
Step 3: Add to PATH¶
# For bash
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc
# For zsh
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc
# For fish
set -Ua fish_user_paths $HOME/.local/bin
Step 4: Verify Installation¶
๐ฏ Platform-Specific Instructions¶
Linux (Ubuntu/Debian)¶
# Install prerequisites
sudo apt update
sudo apt install -y python3.10 python3-pip python3-venv git curl
# Install Annona
curl -fsSL https://install.akaion.com/runner.sh | bash
# Reload shell
source ~/.bashrc
# Authenticate
akaion login
akaion init
akaion run
macOS¶
# Install Homebrew (if not installed)
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
# Install prerequisites
brew install python@3.11 git
# Install Annona
curl -fsSL https://install.akaion.com/runner.sh | bash
# Reload shell
source ~/.zshrc
# Authenticate
akaion login
akaion init
akaion run
Windows (WSL2)¶
# Install WSL2 first (PowerShell as Administrator)
wsl --install
# Then follow Linux instructions inside WSL
๐ง Advanced Installation Options¶
Custom Installation Directory¶
export AKAION_INSTALL_DIR="$HOME/my-custom-path"
curl -fsSL https://install.akaion.com/runner.sh | bash
Specific Version¶
From Source (Development)¶
git clone https://github.com/akaion/akaion-runner.git
cd akaion-runner
python3 -m venv env
source env/bin/activate
pip install -e .
๐ณ Docker Installation¶
Pull Image¶
Run Container¶
docker run -d \
--name akaion-runner \
-e AKAION_API_KEY=your_api_key \
-v ~/.akaion:/root/.akaion \
akaion/runner:latest
Docker Compose¶
version: '3.8'
services:
akaion-runner:
image: akaion/runner:latest
container_name: akaion-runner
environment:
- AKAION_API_KEY=${AKAION_API_KEY}
volumes:
- ~/.akaion:/root/.akaion
restart: unless-stopped
๐ Auto-Start Setup¶
Linux (systemd)¶
# Enable service
systemctl --user enable akaion-runner
# Start service
systemctl --user start akaion-runner
# Check status
systemctl --user status akaion-runner
# View logs
journalctl --user -u akaion-runner -f
macOS (launchd)¶
# Load LaunchAgent
launchctl load ~/Library/LaunchAgents/com.akaion.runner.plist
# Check status
launchctl list | grep akaion
# View logs
tail -f ~/Library/Logs/akaion-runner.log
๐ Post-Installation Setup¶
1. Authenticate¶
2. Initialize Configuration¶
3. Test Installation¶
# Check status
akaion status
# Run once
akaion run --once --task "Echo test"
# Start daemon
akaion run
๐ Verify Installation¶
Check Components¶
# Version
akaion version
# Status
akaion status --verbose
# Configuration
akaion config --show
# Test connectivity
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://api.prod.akaion.com/health
Directory Structure¶
~/.akaion-runner/ # Installation directory
โโโ cli.py
โโโ runner/
โโโ env/ # Virtual environment
โโโ ...
~/.akaion/ # User configuration
โโโ config.yaml
โโโ auth.json # Encrypted credentials
โโโ logs/
โโโ runner.log
~/.local/bin/
โโโ akaion # Executable symlink
๐ ๏ธ Troubleshooting¶
Command not found: akaion¶
# Check if in PATH
echo $PATH | grep .local/bin
# Add to PATH manually
export PATH="$HOME/.local/bin:$PATH"
# Make permanent
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc
Python version error¶
# Check Python version
python3 --version
# Install Python 3.10+ (Ubuntu)
sudo apt install python3.10 python3.10-venv
# Update alternatives
sudo update-alternatives --install /usr/bin/python3 python3 /usr/bin/python3.10 1
Permission denied errors¶
# Make scripts executable
chmod +x ~/.akaion-runner/install.sh
chmod +x ~/.local/bin/akaion
# Fix ownership
chown -R $USER:$USER ~/.akaion-runner
chown -R $USER:$USER ~/.akaion
Installation script fails¶
# Enable debug mode
bash -x <(curl -fsSL https://install.akaion.com/runner.sh)
# Or manual installation
git clone https://github.com/akaion/akaion-runner.git
cd akaion-runner
./install.sh
๐๏ธ Uninstallation¶
Quick Uninstall¶
Manual Uninstall¶
# Stop services
systemctl --user stop akaion-runner
systemctl --user disable akaion-runner
# Remove files
rm -rf ~/.akaion-runner
rm -rf ~/.akaion # Optional: removes config
rm ~/.local/bin/akaion
๐ Installation Verification Checklist¶
- [ ] Python 3.10+ installed
- [ ] Git installed
- [ ] Repository cloned successfully
- [ ] Virtual environment created
- [ ] Dependencies installed
- [ ]
akaioncommand available - [ ] Authentication successful
- [ ] Configuration initialized
- [ ] Annona starts without errors
- [ ] Can connect to cloud backend
๐ Support¶
If you encounter issues:
- Check Troubleshooting section
- View logs:
akaion logs --tail 100 - Check status:
akaion status --verbose - Report issues: https://github.com/akaion/akaion-runner/issues
๐ Next Steps¶
After installation:
- Read QUICKSTART.md for usage guide
- Check ARCHITECTURE.md for technical details
- Configure permissions in ~/.akaion/config.yaml
- Set up auto-start with systemd/launchd