Installation
Get AKIOS running in 2 minutes. Choose the method that works best for you.
Quick Install (Most Users)
On Linux (maximum security with kernel-hard isolation):
pip install akios>=1.0.15
akios init my-project
cd my-project
akios run templates/hello-workflow.yml
On macOS/Windows or for teams (Docker provides strong cross-platform security):
curl -O https://raw.githubusercontent.com/akios-ai/akios/main/src/akios/cli/data/wrapper.sh
mv wrapper.sh akios
chmod +x akios
./akios init my-project
cd my-project
./akios run templates/hello-workflow.yml
That's it! The setup wizard will guide you through API key configuration on first run.
Which Should I Use?
| Your Situation | Use This | Why |
|---|---|---|
| I'm on Linux and want max security | Pip | Full kernel isolation, fastest performance |
| I'm on macOS or Windows | Docker | Only option (Docker required) |
| My team uses different platforms | Docker | Everyone gets identical setup |
| I need it in CI/CD pipelines | Docker (Direct) | Easy automation, no wrapper needed |
| I do Python development | Pip | Access to Python libraries and extensions |
Two Installation Options
Option 1: Pip Package (Linux Only)
Best for: Developers, CI/CD pipelines, custom extensions, full Python ecosystem access
What you get: Native Python installation - access to Python libraries, plugins, and custom extensions (ecosystem integration)
Requirements: Python 3.9 or higher
Linux prerequisites for full kernel-hard security:
# Install system packages for seccomp support
sudo apt install libseccomp-dev python3-seccomp
# Ubuntu 24.04+ users: Use pipx instead of pip due to PEP 668
sudo apt install pipx
pipx install akios>=1.0.15
# Other users (Ubuntu 20.04/22.04, macOS, Windows):
pip install akios>=1.0.15
# Or install a specific version:
pip install akios==1.0.15
# Verify installation
akios --version
akios init my-project
cd my-project
Option 2: Docker (macOS, Windows, Linux)
Best for: Teams using containers, cloud deployments, CI/CD, zero-setup environments
Prerequisites: Docker must be installed (download from docker.com)
What you get: Containerized deployment works everywhere - same environment on every machine, no Python installation needed
Option A: Direct Docker (for automation/CI/CD):
# Pull the Docker image
docker pull akiosai/akios:v1.0.15
# Initialize a new project
docker run --rm -v "$(pwd):/app" -w /app akiosai/akios:v1.0.15 init my-project
# Run workflows
cd my-project
docker run --rm -v "$(pwd):/app" -w /app akiosai/akios:v1.0.15 run templates/hello-workflow.yml
Option B: Docker wrapper script (recommended - easier commands):
# Create wrapper script (one-time setup)
curl -O https://raw.githubusercontent.com/akios-ai/akios/main/src/akios/cli/data/wrapper.sh
mv wrapper.sh akios
chmod +x akios
# Now use ./akios like native installation
./akios init my-project
cd my-project
./akios run templates/hello-workflow.yml
# Force refresh image (pull latest)
AKIOS_FORCE_PULL=1 ./akios status
Setup Your API Keys
After installation, configure your AI provider (first run only):
# The setup wizard runs automatically
akios run templates/hello-workflow.yml
# Or run it manually anytime
akios setup
The wizard helps you:
- Choose your AI provider (OpenAI, Anthropic, Grok, Mistral, Gemini, AWS Bedrock)
- Add your API key securely (or configure IAM for Bedrock)
- Set budget limits
- Test everything works
Get free API keys:
- OpenAI - GPT-4, GPT-3.5
- Anthropic - Claude models
- xAI - Grok models
- Mistral - Mistral models
- Google - Gemini models
- AWS Bedrock - Claude, Llama, Titan (IAM auth, no API key needed)
Verify Everything Works
# Check version
akios --version
# See available templates
akios templates list
# Run a workflow
akios run templates/hello-workflow.yml
# Check the results
akios files
akios status
Security Levels Explained
On Linux (Pip): Full kernel-hard security
- cgroups v2 resource isolation
- seccomp-bpf syscall filtering
- Maximum protection
With Docker (All Platforms): Strong policy-based security
- Container isolation
- Command allowlisting
- PII redaction
- Comprehensive audit logging
Both options provide production-grade security. Linux pip gives you the absolute maximum, Docker gives you excellent security everywhere.
Troubleshooting
"pip install failed"
# Upgrade pip first
pip install --upgrade pip
# Or use pipx on Ubuntu 24.04+
sudo apt install pipx
pipx install akios
"Docker wrapper won't download" Use Direct Docker method instead - it doesn't need the wrapper script.
"Permission denied with Docker"
# On Linux, add yourself to docker group
sudo usermod -aG docker $USER
# Then log out and back in
Need more help? See the Debugging guide or check GitHub Issues.
What's Next?
- Quickstart - Complete tutorial from zero to your first AI workflow
- Concepts - Understand how AKIOS works
- Security - Deep dive into the security features
- CLI Reference - All available commands