This guide covers multiple deployment options for Nanobot, from quick local testing to production-ready server deployments.
# Install from PyPI
pip install nanobot-ai
# Or use uv for faster installation
uv tool install nanobot-ai
# Initialize configuration
nanobot onboard
# Configure API keys in ~/.nanobot/config.json
# Run your first agent command
nanobot agent -m "What is 2+2?"
# Clone repository
git clone https://github.com/HKUDS/nanobot
cd nanobot
# First-time setup
docker compose run --rm nanobot-cli onboard
# Edit configuration
vim ~/.nanobot/config.json
# Start gateway
docker compose up -d nanobot-gateway
# Clone repository
git clone https://github.com/HKUDS/nanobot
cd nanobot
# Install in editable mode
pip install -e .
# Initialize
nanobot onboard
| Component | Requirement | Notes |
|---|---|---|
| Python | 3.11 or 3.12 | Required for all installation methods |
| Node.js | 18+ (20+ recommended) | Only required for WhatsApp channel |
| Git | Any recent version | For source installation |
| Docker | 20.10.0+ | For Docker deployment |
| Docker Compose | 2.0.0+ | For Docker Compose deployment |
After installation, configure Nanobot:
nanobot onboard creates config directory~/.nanobot/config.json{
"providers": {
"openrouter": {
"apiKey": "sk-or-v1-your-key"
}
},
"agents": {
"defaults": {
"model": "anthropic/claude-opus-4-5",
"provider": "openrouter"
}
},
"channels": {
"telegram": {
"enabled": true,
"token": "YOUR_BOT_TOKEN",
"allowFrom": ["YOUR_USER_ID"]
}
}
}
| Provider | API Key | Get Key At |
|---|---|---|
| OpenRouter | sk-or-v1-xxx |
https://openrouter.ai/keys |
| Provider | API Key Format | Get Key At |
|---|---|---|
| Anthropic | API key | https://console.anthropic.com |
| OpenAI | API key | https://platform.openai.com |
| DeepSeek | API key | https://platform.deepseek.com |
| Groq | API key | https://console.groq.com |
| Google Gemini | API key | https://aistudio.google.com |
| Zhipu | API key | https://open.bigmodel.cn |
| Platform | Credentials | Notes |
|---|---|---|
| Telegram | Bot token | From @BotFather (easiest) |
| Discord | Bot token | Requires Message Content intent |
| QR scan | Requires Node.js 18+ | |
| Slack | Bot token + App token | Socket Mode recommended |
| IMAP/SMTP | App passwords recommended |
Choose your deployment method:
Setting up Nanobot can be complex. We offer consulting services for:
Contact us at office@linux-server-admin.com or visit our contact page.