Installation
Get ayo running on your machine in a few minutes.
Requirements
- Go 1.21+ — Install from go.dev
- macOS or Linux — Windows is supported via WSL
- API Key — From Anthropic, OpenAI, or OpenRouter
Install via Go
The simplest way to install ayo:
go install github.com/ayo-ooo/ayo/cmd/ayo@latest
This installs the ayo binary to your $GOPATH/bin directory.
Make sure this directory is in your PATH.
Configure Your API Key
ayo needs access to an LLM provider. Set your API key as an environment variable:
Anthropic (Recommended)
export ANTHROPIC_API_KEY="sk-ant-..."
OpenAI
export OPENAI_API_KEY="sk-..."
OpenRouter
export OPENROUTER_API_KEY="sk-or-..."
Add this to your shell configuration (~/.bashrc, ~/.zshrc, etc.) to persist it.
Run Setup
Initialize ayo with the setup wizard:
ayo setup
This creates the necessary directories, verifies your API key, and configures default settings.
Verify Installation
Check that everything is working:
ayo doctor
This command checks:
- API key configuration
- Directory structure
- Sandbox availability
- Database connection
Start Chatting
You're ready to go. Start an interactive session:
ayo
Or send a single prompt:
ayo "What can you help me with?"
Troubleshooting
Command not found
Make sure $GOPATH/bin is in your PATH. Add this to your shell config:
export PATH="$PATH:$(go env GOPATH)/bin"
API key errors
Verify your API key is set correctly:
echo $ANTHROPIC_API_KEY
If empty, set it again and source your shell config.
Permission errors
If you see permission errors during setup, ensure you have write access to
~/.config/ayo and ~/.local/share/ayo.
Next Steps
Now that ayo is installed, create your first agent.