🐈 nanobot is an ultra-lightweight personal AI assistant inspired by OpenClaw.
⚡️ Delivers core agent functionality with 99% fewer lines of code than OpenClaw.
📏 Real-time line count: run bash core_agent_lines.sh to verify anytime.
/restart, and sturdier memory.🪶 Ultra-Lightweight: A super lightweight implementation of OpenClaw — 99% smaller, significantly faster.
🔬 Research-Ready: Clean, readable code that's easy to understand, modify, and extend for research.
⚡️ Lightning Fast: Minimal footprint means faster startup, lower resource usage, and quicker iterations.
💎 Easy-to-Use: One-click to deploy and you're ready to go.
📈 24/7 Real-Time Market Analysis | 🚀 Full-Stack Software Engineer | 📅 Smart Daily Routine Manager | 📚 Personal Knowledge Assistant |
|---|---|---|---|
|
|
|
|
| Discovery • Insights • Trends | Develop • Deploy • Scale | Schedule • Automate • Organize | Learn • Memory • Reasoning |
Install from source (latest features, recommended for development)
git clone https://github.com/HKUDS/nanobot.git
cd nanobot
pip install -e .
Install with uv (stable, fast)
uv tool install nanobot-ai
Install from PyPI (stable)
pip install nanobot-ai
PyPI / pip
pip install -U nanobot-ai nanobot --version
uv
uv tool upgrade nanobot-ai nanobot --version
Using WhatsApp? Rebuild the local bridge after upgrading:
rm -rf ~/.nanobot/bridge
nanobot channels login
TIP
Set your API key in ~/.nanobot/config.json.
Get API keys: OpenRouter (Global)
For web search capability setup, please see Web Search.
1. Initialize
nanobot onboard
2. Configure (~/.nanobot/config.json)
Add or merge these two parts into your config (other options have defaults).
Set your API key (e.g. OpenRouter, recommended for global users):
{
"providers": {
"openrouter": {
"apiKey": "sk-or-v1-xxx"
}
}
}
Set your model (optionally pin a provider — defaults to auto-detection):
{
"agents": {
"defaults": {
"model": "anthropic/claude-opus-4-5",
"provider": "openrouter"
}
}
}
3. Chat
nanobot agent
That's it! You have a working AI assistant in 2 minutes.
Connect nanobot to your favorite chat platform. Want to build your own? See the Channel Plugin Guide.
Channel plugin support is available in the
mainbranch; not yet published to PyPI.
| Channel | What you need |
|---|---|
| Telegram | Bot token from @BotFather |
| Discord | Bot token + Message Content intent |
| QR code scan | |
| Feishu | App ID + App Secret |
| Mochat | Claw token (auto-setup available) |
| DingTalk | App Key + App Secret |
| Slack | Bot token + App-Level token |
| IMAP/SMTP credentials | |
| App ID + App Secret | |
| Wecom | Bot ID + Bot Secret |
1. Create a bot
@BotFather/newbot, follow prompts2. Configure
{
"channels": {
"telegram": {
"enabled": true,
"token": "YOUR_BOT_TOKEN",
"allowFrom": ["YOUR_USER_ID"]
}
}
}
You can find your User ID in Telegram settings. It is shown as
@yourUserId. Copy this value without the@symbol and paste it into the config file.
3. Run
nanobot gateway
Uses Socket.IO WebSocket by default, with HTTP polling fallback.
1. Ask nanobot to set up Mochat for you
Simply send this message to nanobot (replace xxx@xxx with your real email):
Read https://raw.githubusercontent.com/HKUDS/MoChat/refs/heads/main/skills/nanobot/skill.md and register on MoChat. My Email account is xxx@xxx Bind me as your owner and DM me on MoChat.
nanobot will automatically register, configure ~/.nanobot/config.json, and connect to Mochat.
2. Restart gateway
nanobot gateway
That's it — nanobot handles the rest!
If you prefer to configure manually, add the following to ~/.nanobot/config.json:
Keep
claw_tokenprivate. It should only be sent inX-Claw-Tokenheader to your Mochat API endpoint.
{
"channels": {
"mochat": {
"enabled": true,
"base_url": "https://mochat.io",
"socket_url": "https://mochat.io",
"socket_path": "/socket.io",
"claw_token": "claw_xxx",
"agent_user_id": "6982abcdef",
"sessions": ["*"],
"panels": ["*"],
"reply_delay_mode": "non-mention",
"reply_delay_ms": 120000
}
}
}
1. Create a bot
2. Enable intents
3. Get your User ID
4. Configure
{
"channels": {
"discord": {
"enabled": true,
"token": "YOUR_BOT_TOKEN",
"allowFrom": ["YOUR_USER_ID"],
"groupPolicy": "mention"
}
}
}
groupPolicycontrols how the bot responds in group channels:
"mention"(default) — Only respond when @mentioned"open"— Respond to all messages DMs always respond when the sender is inallowFrom.
5. Invite the bot
botSend Messages, Read Message History6. Run
nanobot gateway
Install Matrix dependencies first:
pip install nanobot-ai[matrix]
1. Create/choose a Matrix account
matrix.org).2. Get credentials
userId (example: @nanobot:matrix.org)accessTokendeviceId (recommended so sync tokens can be restored across restarts)/_matrix/client/v3/login) or from your client's advanced session settings.3. Configure
{
"channels": {
"matrix": {
"enabled": true,
"homeserver": "https://matrix.org",
"userId": "@nanobot:matrix.org",
"accessToken": "syt_xxx",
"deviceId": "NANOBOT01",
"e2eeEnabled": true,
"allowFrom": ["@your_user:matrix.org"],
"groupPolicy": "open",
"groupAllowFrom": [],
"allowRoomMentions": false,
"maxMediaBytes": 20971520
}
}
}
Keep a persistent
matrix-storeand stabledeviceId— encrypted session state is lost if these change across restarts.
| Option | Description |
|---|---|
allowFrom | User IDs allowed to interact. Empty denies all; use ["*"] to allow everyone. |
groupPolicy | open (default), mention, or allowlist. |
groupAllowFrom | Room allowlist (used when policy is allowlist). |
allowRoomMentions | Accept @room mentions in mention mode. |
e2eeEnabled | E2EE support (default true). Set false for plaintext-only. |
maxMediaBytes | Max attachment size (default 20MB). Set 0 to block all media. |
4. Run
nanobot gateway
Requires Node.js ≥18.
1. Link device
nanobot channels login
# Scan QR with WhatsApp → Settings → Linked Devices
2. Configure
{
"channels": {
"whatsapp": {
"enabled": true,
"allowFrom": ["+1234567890"]
}
}
}
3. Run (two terminals)
# Terminal 1
nanobot channels login
# Terminal 2
nanobot gateway
WhatsApp bridge updates are not applied automatically for existing installations. After upgrading nanobot, rebuild the local bridge with:
rm -rf ~/.nanobot/bridge && nanobot channels login
Uses WebSocket long connection — no public IP required.
1. Create a Feishu bot
im:message (send messages) and im:message.p2p_msg:readonly (receive messages)im.message.receive_v1 (receive messages)
2. Configure
{
"channels": {
"feishu": {
"enabled": true,
"appId": "cli_xxx",
"appSecret": "xxx",
"encryptKey": "",
"verificationToken": "",
"allowFrom": ["ou_YOUR_OPEN_ID"],
"groupPolicy": "mention"
}
}
}
encryptKeyandverificationTokenare optional for Long Connection mode.allowFrom: Add your open_id (find it in nanobot logs when you message the bot). Use["*"]to allow all users.groupPolicy:"mention"(default — respond only when @mentioned),"open"(respond to all group messages). Private chats always respond.
3. Run
nanobot gateway
TIP
Feishu uses WebSocket to receive messages — no webhook or public IP needed!
Uses botpy SDK with WebSocket — no public IP required. Currently supports private messages only.
1. Register & create bot
2. Set up sandbox for testing
3. Configure
allowFrom: Add your openid (find it in nanobot logs when you message the bot). Use["*"]for public access.msgFormat: Optional. Use"plain"(default) for maximum compatibility with legacy QQ clients, or"markdown"for richer formatting on newer clients.- For production: submit a review in the bot console and publish. See QQ Bot Docs for the full publishing flow.
{
"channels": {
"qq": {
"enabled": true,
"appId": "YOUR_APP_ID",
"secret": "YOUR_APP_SECRET",
"allowFrom": ["YOUR_OPENID"],
"msgFormat": "plain"
}
}
}
4. Run
nanobot gateway
Now send a message to the bot from QQ — it should respond!
Uses Stream Mode — no public IP required.
1. Create a DingTalk bot
2. Configure
{
"channels": {
"dingtalk": {
"enabled": true,
"clientId": "YOUR_APP_KEY",
"clientSecret": "YOUR_APP_SECRET",
"allowFrom": ["YOUR_STAFF_ID"]
}
}
}
allowFrom: Add your staff ID. Use["*"]to allow all users.
3. Run
nanobot gateway
Uses Socket Mode — no public URL required.
1. Create a Slack app
2. Configure the app
connections:write scope → copy it (xapp-...)chat:write, reactions:write, app_mentions:readmessage.im, message.channels, app_mention → Save Changesxoxb-...)3. Configure nanobot
{
"channels": {
"slack": {
"enabled": true,
"botToken": "xoxb-...",
"appToken": "xapp-...",
"allowFrom": ["YOUR_SLACK_USER_ID"],
"groupPolicy": "mention"
}
}
}
4. Run
nanobot gateway
DM the bot directly or @mention it in a channel — it should respond!
TIP
groupPolicy: "mention" (default — respond only when @mentioned), "open" (respond to all channel messages), or "allowlist" (restrict to specific channels)."dm": {"enabled": false} to disable DMs.Give nanobot its own email account. It polls IMAP for incoming mail and replies via SMTP — like a personal email assistant.
1. Get credentials (Gmail example)
my-nanobot@gmail.com)2. Configure
consentGrantedmust betrueto allow mailbox access. This is a safety gate — setfalseto fully disable.allowFrom: Add your email address. Use["*"]to accept emails from anyone.smtpUseTlsandsmtpUseSsldefault totrue/falserespectively, which is correct for Gmail (port 587 + STARTTLS). No need to set them explicitly.- Set
"autoReplyEnabled": falseif you only want to read/analyze emails without sending automatic replies.
{
"channels": {
"email": {
"enabled": true,
"consentGranted": true,
"imapHost": "imap.gmail.com",
"imapPort": 993,
"imapUsername": "my-nanobot@gmail.com",
"imapPassword": "your-app-password",
"smtpHost": "smtp.gmail.com",
"smtpPort": 587,
"smtpUsername": "my-nanobot@gmail.com",
"smtpPassword": "your-app-password",
"fromAddress": "my-nanobot@gmail.com",
"allowFrom": ["your-real-email@gmail.com"]
}
}
}
3. Run
nanobot gateway
Here we use wecom-aibot-sdk-python (community Python version of the official @wecom/aibot-node-sdk).
Uses WebSocket long connection — no public IP required.
1. Install the optional dependency
pip install nanobot-ai[wecom]
2. Create a WeCom AI Bot
Go to the WeCom admin console → Intelligent Robot → Create Robot → select API mode with long connection. Copy the Bot ID and Secret.
3. Configure
{
"channels": {
"wecom": {
"enabled": true,
"botId": "your_bot_id",
"secret": "your_bot_secret",
"allowFrom": ["your_id"]
}
}
}
4. Run
nanobot gateway
🐈 nanobot is capable of linking to the agent social network (agent community). Just send one message and your nanobot joins automatically!
| Platform | How to Join (send this message to your bot) |
|---|---|
| Moltbook | Read https://moltbook.com/skill.md and follow the instructions to join Moltbook |
| ClawdChat | Read https://clawdchat.ai/skill.md and follow the instructions to join ClawdChat |
Simply send the command above to your nanobot (via CLI or any chat channel), and it will handle the rest.
Config file: ~/.nanobot/config.json
TIP
volcengineCodingPlan or byteplusCodingPlan instead of the pay-per-use volcengine / byteplus providers."apiBase": "https://open.bigmodel.cn/api/coding/paas/v4" in your zhipu provider config."apiBase": "https://api.minimaxi.com/v1" in your minimax provider config."apiBase": "https://dashscope.aliyuncs.com/compatible-mode/v1" in your dashscope provider config.| Provider | Purpose | Get API Key |
|---|---|---|
custom | Any OpenAI-compatible endpoint (direct, no LiteLLM) | — |
openrouter | LLM (recommended, access to all models) | openrouter.ai |
volcengine | LLM (VolcEngine, pay-per-use) | Coding Plan · volcengine.com |
byteplus | LLM (VolcEngine international, pay-per-use) | Coding Plan · byteplus.com |
anthropic | LLM (Claude direct) | console.anthropic.com |
azure_openai | LLM (Azure OpenAI) | portal.azure.com |
openai | LLM (GPT direct) | platform.openai.com |
deepseek | LLM (DeepSeek direct) | platform.deepseek.com |
groq | LLM + Voice transcription (Whisper) | console.groq.com |
gemini | LLM (Gemini direct) | aistudio.google.com |
minimax | LLM (MiniMax direct) | platform.minimaxi.com |
aihubmix | LLM (API gateway, access to all models) | aihubmix.com |
siliconflow | LLM (SiliconFlow/硅基流动) | siliconflow.cn |
dashscope | LLM (Qwen) | dashscope.console.aliyun.com |
moonshot | LLM (Moonshot/Kimi) | platform.moonshot.cn |
zhipu | LLM (Zhipu GLM) | open.bigmodel.cn |
ollama | LLM (local, Ollama) | — |
vllm | LLM (local, any OpenAI-compatible server) | — |
openai_codex | LLM (Codex, OAuth) | nanobot provider login openai-codex |
github_copilot | LLM (GitHub Copilot, OAuth) | nanobot provider login github-copilot |
Codex uses OAuth instead of API keys. Requires a ChatGPT Plus or Pro account.
1. Login:
nanobot provider login openai-codex
2. Set model (merge into ~/.nanobot/config.json):
{
"agents": {
"defaults": {
"model": "openai-codex/gpt-5.1-codex"
}
}
}
3. Chat:
nanobot agent -m "Hello!"
# Target a specific workspace/config locally
nanobot agent -c ~/.nanobot-telegram/config.json -m "Hello!"
# One-off workspace override on top of that config
nanobot agent -c ~/.nanobot-telegram/config.json -w /tmp/nanobot-telegram-test -m "Hello!"
Docker users: use
docker run -itfor interactive OAuth login.
Connects directly to any OpenAI-compatible endpoint — LM Studio, llama.cpp, Together AI, Fireworks, Azure OpenAI, or any self-hosted server. Bypasses LiteLLM; model name is passed as-is.
{
"providers": {
"custom": {
"apiKey": "your-api-key",
"apiBase": "https://api.your-provider.com/v1"
}
},
"agents": {
"defaults": {
"model": "your-model-name"
}
}
}
For local servers that don't require a key, set
apiKeyto any non-empty string (e.g."no-key").
Run a local model with Ollama, then add to config:
1. Start Ollama (example):
ollama run llama3.2
2. Add to config (partial — merge into ~/.nanobot/config.json):
{
"providers": {
"ollama": {
"apiBase": "http://localhost:11434"
}
},
"agents": {
"defaults": {
"provider": "ollama",
"model": "llama3.2"
}
}
}
provider: "auto"also works whenproviders.ollama.apiBaseis configured, but setting"provider": "ollama"is the clearest option.
Run your own model with vLLM or any OpenAI-compatible server, then add to config:
1. Start the server (example):
vllm serve meta-llama/Llama-3.1-8B-Instruct --port 8000
2. Add to config (partial — merge into ~/.nanobot/config.json):
Provider (key can be any non-empty string for local):
{
"providers": {
"vllm": {
"apiKey": "dummy",
"apiBase": "http://localhost:8000/v1"
}
}
}
Model:
{
"agents": {
"defaults": {
"model": "meta-llama/Llama-3.1-8B-Instruct"
}
}
}
nanobot uses a Provider Registry (nanobot/providers/registry.py) as the single source of truth.
Adding a new provider only takes 2 steps — no if-elif chains to touch.
Step 1. Add a ProviderSpec entry to PROVIDERS in nanobot/providers/registry.py:
ProviderSpec(
name="myprovider", # config field name
keywords=("myprovider", "mymodel"), # model-name keywords for auto-matching
env_key="MYPROVIDER_API_KEY", # env var for LiteLLM
display_name="My Provider", # shown in `nanobot status`
litellm_prefix="myprovider", # auto-prefix: model → myprovider/model
skip_prefixes=("myprovider/",), # don't double-prefix
)
Step 2. Add a field to ProvidersConfig in nanobot/config/schema.py:
class ProvidersConfig(BaseModel):
...
myprovider: ProviderConfig = ProviderConfig()
That's it! Environment variables, model prefixing, config matching, and nanobot status display will all work automatically.
Common ProviderSpec options:
| Field | Description | Example |
|---|---|---|
litellm_prefix | Auto-prefix model names for LiteLLM | "dashscope" → dashscope/qwen-max |
skip_prefixes | Don't prefix if model already starts with these | ("dashscope/", "openrouter/") |
env_extras | Additional env vars to set | (("ZHIPUAI_API_KEY", "{api_key}"),) |
model_overrides | Per-model parameter overrides | (("kimi-k2.5", {"temperature": 1.0}),) |
is_gateway | Can route any model (like OpenRouter) | True |
detect_by_key_prefix | Detect gateway by API key prefix | "sk-or-" |
detect_by_base_keyword | Detect gateway by API base URL | "openrouter" |
strip_model_prefix | Strip existing prefix before re-prefixing | True (for AiHubMix) |
TIP
Use proxy in tools.web to route all web requests (search + fetch) through a proxy:
{ "tools": { "web": { "proxy": "http://127.0.0.1:7890" } } }
nanobot supports multiple web search providers. Configure in ~/.nanobot/config.json under tools.web.search.
| Provider | Config fields | Env var fallback | Free |
|---|---|---|---|
brave (default) | apiKey | BRAVE_API_KEY | No |
tavily | apiKey | TAVILY_API_KEY | No |
jina | apiKey | JINA_API_KEY | Free tier (10M tokens) |
searxng | baseUrl | SEARXNG_BASE_URL | Yes (self-hosted) |
duckduckgo | — | — | Yes |
When credentials are missing, nanobot automatically falls back to DuckDuckGo.
Brave (default):
{
"tools": {
"web": {
"search": {
"provider": "brave",
"apiKey": "BSA..."
}
}
}
}
Tavily:
{
"tools": {
"web": {
"search": {
"provider": "tavily",
"apiKey": "tvly-..."
}
}
}
}
Jina (free tier with 10M tokens):
{
"tools": {
"web": {
"search": {
"provider": "jina",
"apiKey": "jina_..."
}
}
}
}
SearXNG (self-hosted, no API key needed):
{
"tools": {
"web": {
"search": {
"provider": "searxng",
"baseUrl": "https://searx.example"
}
}
}
}
DuckDuckGo (zero config):
{
"tools": {
"web": {
"search": {
"provider": "duckduckgo"
}
}
}
}
| Option | Type | Default | Description |
|---|---|---|---|
provider | string | "brave" | Search backend: brave, tavily, jina, searxng, duckduckgo |
apiKey | string | "" | API key for Brave or Tavily |
baseUrl | string | "" | Base URL for SearXNG |
maxResults | integer | 5 | Results per search (1–10) |
TIP
The config format is compatible with Claude Desktop / Cursor. You can copy MCP server configs directly from any MCP server's README.
nanobot supports MCP — connect external tool servers and use them as native agent tools.
Add MCP servers to your config.json:
{
"tools": {
"mcpServers": {
"filesystem": {
"command": "npx",
"args": ["-y", "@modelcontextprotocol/server-filesystem", "/path/to/dir"]
},
"my-remote-mcp": {
"url": "https://example.com/mcp/",
"headers": {
"Authorization": "Bearer xxxxx"
}
}
}
}
}
Two transport modes are supported:
| Mode | Config | Example |
|---|---|---|
| Stdio | command + args | Local process via npx / uvx |
| HTTP | url + headers (optional) | Remote endpoint (https://mcp.example.com/sse) |
Use toolTimeout to override the default 30s per-call timeout for slow servers:
{
"tools": {
"mcpServers": {
"my-slow-server": {
"url": "https://example.com/mcp/",
"toolTimeout": 120
}
}
}
}
Use enabledTools to register only a subset of tools from an MCP server:
{
"tools": {
"mcpServers": {
"filesystem": {
"command": "npx",
"args": ["-y", "@modelcontextprotocol/server-filesystem", "/path/to/dir"],
"enabledTools": ["read_file", "mcp_filesystem_write_file"]
}
}
}
}
enabledTools accepts either the raw MCP tool name (for example read_file) or the wrapped nanobot tool name (for example mcp_filesystem_write_file).
enabledTools, or set it to ["*"], to register all tools.enabledTools to [] to register no tools from that server.enabledTools to a non-empty list of names to register only that subset.MCP tools are automatically discovered and registered on startup. The LLM can use them alongside built-in tools — no extra configuration needed.
TIP
For production deployments, set "restrictToWorkspace": true in your config to sandbox the agent.
In v0.1.4.post3 and earlier, an empty allowFrom allowed all senders. Since v0.1.4.post4, empty allowFrom denies all access by default. To allow all senders, set "allowFrom": ["*"].
| Option | Default | Description |
|---|---|---|
tools.restrictToWorkspace | false | When true, restricts all agent tools (shell, file read/write/edit, list) to the workspace directory. Prevents path traversal and out-of-scope access. |
tools.exec.pathAppend | "" | Extra directories to append to PATH when running shell commands (e.g. /usr/sbin for ufw). |
channels.*.allowFrom | [] (deny all) | Whitelist of user IDs. Empty denies all; use ["*"] to allow everyone. |
Run multiple nanobot instances simultaneously with separate configs and runtime data. Use --config as the main entrypoint, and optionally use --workspace to override the workspace for a specific run.
# Instance A - Telegram bot
nanobot gateway --config ~/.nanobot-telegram/config.json
# Instance B - Discord bot
nanobot gateway --config ~/.nanobot-discord/config.json
# Instance C - Feishu bot with custom port
nanobot gateway --config ~/.nanobot-feishu/config.json --port 18792
When using --config, nanobot derives its runtime data directory from the config file location. The workspace still comes from agents.defaults.workspace unless you override it with --workspace.
To open a CLI session against one of these instances locally:
nanobot agent -c ~/.nanobot-telegram/config.json -m "Hello from Telegram instance"
nanobot agent -c ~/.nanobot-discord/config.json -m "Hello from Discord instance"
# Optional one-off workspace override
nanobot agent -c ~/.nanobot-telegram/config.json -w /tmp/nanobot-telegram-test
nanobot agentstarts a local CLI agent using the selected workspace/config. It does not attach to or proxy through an already runningnanobot gatewayprocess.
| Component | Resolved From | Example |
|---|---|---|
| Config | --config path | ~/.nanobot-A/config.json |
| Workspace | --workspace or config | ~/.nanobot-A/workspace/ |
| Cron Jobs | config directory | ~/.nanobot-A/cron/ |
| Media / runtime state | config directory | ~/.nanobot-A/media/ |
--config selects which config file to loadagents.defaults.workspace in that config--workspace, it overrides the workspace from the config fileagents.defaults.workspace for that instance.--config.Example config:
{
"agents": {
"defaults": {
"workspace": "~/.nanobot-telegram/workspace",
"model": "anthropic/claude-sonnet-4-6"
}
},
"channels": {
"telegram": {
"enabled": true,
"token": "YOUR_TELEGRAM_BOT_TOKEN"
}
},
"gateway": {
"port": 18790
}
}
Start separate instances:
nanobot gateway --config ~/.nanobot-telegram/config.json nanobot gateway --config ~/.nanobot-discord/config.json
Override workspace for one-off runs when needed:
nanobot gateway --config ~/.nanobot-telegram/config.json --workspace /tmp/nanobot-telegram-test
--workspace overrides the workspace defined in the config file| Command | Description |
|---|---|
nanobot onboard | Initialize config & workspace |
nanobot agent -m "..." | Chat with the agent |
nanobot agent -w <workspace> | Chat against a specific workspace |
nanobot agent -w <workspace> -c <config> | Chat against a specific workspace/config |
nanobot agent | Interactive chat mode |
nanobot agent --no-markdown | Show plain-text replies |
nanobot agent --logs | Show runtime logs during chat |
nanobot gateway | Start the gateway |
nanobot status | Show status |
nanobot provider login openai-codex | OAuth login for providers |
nanobot channels login | Link WhatsApp (scan QR) |
nanobot channels status | Show channel status |
Interactive mode exits: exit, quit, /exit, /quit, :q, or Ctrl+D.
The gateway wakes up every 30 minutes and checks HEARTBEAT.md in your workspace (~/.nanobot/workspace/HEARTBEAT.md). If the file has tasks, the agent executes them and delivers results to your most recently active chat channel.
Setup: edit ~/.nanobot/workspace/HEARTBEAT.md (created automatically by nanobot onboard):
## Periodic Tasks
- [ ] Check weather forecast and send a summary
- [ ] Scan inbox for urgent emails
The agent can also manage this file itself — ask it to "add a periodic task" and it will update HEARTBEAT.md for you.
Note: The gateway must be running (
nanobot gateway) and you must have chatted with the bot at least once so it knows which channel to deliver to.
TIP
The -v ~/.nanobot:/root/.nanobot flag mounts your local config directory into the container, so your config and workspace persist across container restarts.
docker compose run --rm nanobot-cli onboard # first-time setup
vim ~/.nanobot/config.json # add API keys
docker compose up -d nanobot-gateway # start gateway
docker compose run --rm nanobot-cli agent -m "Hello!" # run CLI
docker compose logs -f nanobot-gateway # view logs
docker compose down # stop
# Build the image
docker build -t nanobot .
# Initialize config (first time only)
docker run -v ~/.nanobot:/root/.nanobot --rm nanobot onboard
# Edit config on host to add API keys
vim ~/.nanobot/config.json
# Run gateway (connects to enabled channels, e.g. Telegram/Discord/Mochat)
docker run -v ~/.nanobot:/root/.nanobot -p 18790:18790 nanobot gateway
# Or run a single command
docker run -v ~/.nanobot:/root/.nanobot --rm nanobot agent -m "Hello!"
docker run -v ~/.nanobot:/root/.nanobot --rm nanobot status
Run the gateway as a systemd user service so it starts automatically and restarts on failure.
1. Find the nanobot binary path:
which nanobot # e.g. /home/user/.local/bin/nanobot
2. Create the service file at ~/.config/systemd/user/nanobot-gateway.service (replace ExecStart path if needed):
[Unit]
Description=Nanobot Gateway
After=network.target
[Service]
Type=simple
ExecStart=%h/.local/bin/nanobot gateway
Restart=always
RestartSec=10
NoNewPrivileges=yes
ProtectSystem=strict
ReadWritePaths=%h
[Install]
WantedBy=default.target
3. Enable and start:
systemctl --user daemon-reload
systemctl --user enable --now nanobot-gateway
Common operations:
systemctl --user status nanobot-gateway # check status
systemctl --user restart nanobot-gateway # restart after config changes
journalctl --user -u nanobot-gateway -f # follow logs
If you edit the .service file itself, run systemctl --user daemon-reload before restarting.
Note: User services only run while you are logged in. To keep the gateway running after logout, enable lingering:
loginctl enable-linger $USER
nanobot/ ├── agent/ # 🧠 Core agent logic │ ├── loop.py # Agent loop (LLM ↔ tool execution) │ ├── context.py # Prompt builder │ ├── memory.py # Persistent memory │ ├── skills.py # Skills loader │ ├── subagent.py # Background task execution │ └── tools/ # Built-in tools (incl. spawn) ├── skills/ # 🎯 Bundled skills (github, weather, tmux...) ├── channels/ # 📱 Chat channel integrations (supports plugins) ├── bus/ # 🚌 Message routing ├── cron/ # ⏰ Scheduled tasks ├── heartbeat/ # 💓 Proactive wake-up ├── providers/ # 🤖 LLM providers (OpenRouter, etc.) ├── session/ # 💬 Conversation sessions ├── config/ # ⚙️ Configuration └── cli/ # 🖥️ Commands
PRs welcome! The codebase is intentionally small and readable. 🤗
| Branch | Purpose |
|---|---|
main | Stable releases — bug fixes and minor improvements |
nightly | Experimental features — new features and breaking changes |
Unsure which branch to target? See CONTRIBUTING.md for details.
Roadmap — Pick an item and open a PR!
Thanks for visiting ✨ nanobot!
nanobot is for educational, research, and technical exchange purposes only