Skip to content
/ nanobot Public
forked from bot2046/nanobot

"๐Ÿˆ nanobot: The Ultra-Lightweight OpenClaw"

License

Notifications You must be signed in to change notification settings

orgoj/nanobot

ย 
ย 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

301 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

nanobot

nanobot: Ultra-Lightweight Personal AI Assistant

PyPI Downloads Python License Feishu WeChat Discord

๐Ÿˆ nanobot is an ultra-lightweight personal AI assistant inspired by OpenClaw

โšก๏ธ Delivers core agent functionality in just ~4,000 lines of code โ€” 99% smaller than Clawdbot's 430k+ lines.

๐Ÿ“ Real-time line count: 3,510 lines (run bash core_agent_lines.sh to verify anytime)

๐Ÿ“ข News

  • 2026-02-10 ๐ŸŽ‰ Released v0.1.3.post6 with improvements! Check the updates notes and our roadmap.
  • 2026-02-09 ๐Ÿ’ฌ Added Slack, Email, and QQ support โ€” nanobot now supports multiple chat platforms!
  • 2026-02-08 ๐Ÿ”ง Refactored Providersโ€”adding a new LLM provider now takes just 2 simple steps! Check here.
  • 2026-02-07 ๐Ÿš€ Released v0.1.3.post5 with Qwen support & several key improvements! Check here for details.
  • 2026-02-06 โœจ Added Moonshot/Kimi provider, Discord integration, and enhanced security hardening!
  • 2026-02-05 โœจ Added Feishu channel, DeepSeek provider, and enhanced scheduled tasks support!
  • 2026-02-04 ๐Ÿš€ Released v0.1.3.post4 with multi-provider & Docker support! Check here for details.
  • 2026-02-03 โšก Integrated vLLM for local LLM support and improved natural language task scheduling!
  • 2026-02-02 ๐ŸŽ‰ nanobot officially launched! Welcome to try ๐Ÿˆ nanobot!

Key Features of nanobot:

๐Ÿชถ Ultra-Lightweight: Just ~4,000 lines of core agent code โ€” 99% smaller than Clawdbot.

๐Ÿ”ฌ 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.

๐Ÿ—๏ธ Architecture

nanobot architecture

โœจ Features

๐Ÿ“ˆ 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

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

๐Ÿš€ Quick Start

Tip

Set your API key in ~/.nanobot/config.json. Get API keys: OpenRouter (Global) ยท Brave Search (optional, for web search)

1. Initialize

nanobot onboard

2. Configure (~/.nanobot/config.json)

For OpenRouter - recommended for global users:

{
  "providers": {
    "openrouter": {
      "apiKey": "sk-or-v1-xxx"
    }
  },
  "agents": {
    "defaults": {
      "model": "anthropic/claude-opus-4-5"
    }
  }
}

3. Chat

nanobot agent -m "What is 2+2?"

That's it! You have a working AI assistant in 2 minutes.

๐Ÿ–ฅ๏ธ Local Models (vLLM)

Run nanobot with your own local models using vLLM or any OpenAI-compatible server.

1. Start your vLLM server

vllm serve meta-llama/Llama-3.1-8B-Instruct --port 8000

2. Configure (~/.nanobot/config.json)

{
  "providers": {
    "vllm": {
      "apiKey": "dummy",
      "apiBase": "http://localhost:8000/v1"
    }
  },
  "agents": {
    "defaults": {
      "model": "meta-llama/Llama-3.1-8B-Instruct"
    }
  }
}

3. Chat

nanobot agent -m "Hello from my local LLM!"

Tip

The apiKey can be any non-empty string for local servers that don't require authentication.

๐Ÿ’ฌ Chat Apps

Talk to your nanobot through Telegram, Discord, WhatsApp, Feishu, Mochat, DingTalk, Slack, Email, or QQ โ€” anytime, anywhere.

Channel Setup
Telegram Easy (just a token)
Discord Easy (bot token + intents)
WhatsApp Medium (scan QR)
Feishu Medium (app credentials)
Mochat Medium (claw token + websocket)
DingTalk Medium (app credentials)
Slack Medium (bot + app tokens)
Email Medium (IMAP/SMTP credentials)
QQ Easy (app credentials)
Telegram (Recommended)

1. Create a bot

  • Open Telegram, search @BotFather
  • Send /newbot, follow prompts
  • Copy the token

2. 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
Mochat (Claw IM)

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!


Manual configuration (advanced)

If you prefer to configure manually, add the following to ~/.nanobot/config.json:

Keep claw_token private. It should only be sent in X-Claw-Token header 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
    }
  }
}
Discord

1. Create a bot

2. Enable intents

  • In the Bot settings, enable MESSAGE CONTENT INTENT
  • (Optional) Enable SERVER MEMBERS INTENT if you plan to use allow lists based on member data

3. Get your User ID

  • Discord Settings โ†’ Advanced โ†’ enable Developer Mode
  • Right-click your avatar โ†’ Copy User ID

4. Configure

{
  "channels": {
    "discord": {
      "enabled": true,
      "token": "YOUR_BOT_TOKEN",
      "allowFrom": ["YOUR_USER_ID"]
    }
  }
}

5. Invite the bot

  • OAuth2 โ†’ URL Generator
  • Scopes: bot
  • Bot Permissions: Send Messages, Read Message History
  • Open the generated invite URL and add the bot to your server

6. Run

nanobot gateway
WhatsApp

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
Feishu (้ฃžไนฆ)

Uses WebSocket long connection โ€” no public IP required.

1. Create a Feishu bot

  • Visit Feishu Open Platform
  • Create a new app โ†’ Enable Bot capability
  • Permissions: Add im:message (send messages)
  • Events: Add im.message.receive_v1 (receive messages)
    • Select Long Connection mode (requires running nanobot first to establish connection)
  • Get App ID and App Secret from "Credentials & Basic Info"
  • Publish the app

2. Configure

{
  "channels": {
    "feishu": {
      "enabled": true,
      "appId": "cli_xxx",
      "appSecret": "xxx",
      "encryptKey": "",
      "verificationToken": "",
      "allowFrom": []
    }
  }
}

encryptKey and verificationToken are optional for Long Connection mode. allowFrom: Leave empty to allow all users, or add ["ou_xxx"] to restrict access.

3. Run

nanobot gateway

[!TIP] Feishu uses WebSocket to receive messages โ€” no webhook or public IP needed!

QQ (QQๅ•่Š)

Uses botpy SDK with WebSocket โ€” no public IP required. Currently supports private messages only.

1. Register & create bot

  • Visit QQ Open Platform โ†’ Register as a developer (personal or enterprise)
  • Create a new bot application
  • Go to ๅผ€ๅ‘่ฎพ็ฝฎ (Developer Settings) โ†’ copy AppID and AppSecret

2. Set up sandbox for testing

  • In the bot management console, find ๆฒ™็ฎฑ้…็ฝฎ (Sandbox Config)
  • Under ๅœจๆถˆๆฏๅˆ—่กจ้…็ฝฎ, click ๆทปๅŠ ๆˆๅ‘˜ and add your own QQ number
  • Once added, scan the bot's QR code with mobile QQ โ†’ open the bot profile โ†’ tap "ๅ‘ๆถˆๆฏ" to start chatting

3. Configure

  • allowFrom: Leave empty for public access, or add user openids to restrict. You can find openids in the nanobot logs when a user messages the bot.
  • 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": []
    }
  }
}

4. Run

nanobot gateway

Now send a message to the bot from QQ โ€” it should respond!

DingTalk (้’‰้’‰)

Uses Stream Mode โ€” no public IP required.

1. Create a DingTalk bot

  • Visit DingTalk Open Platform
  • Create a new app -> Add Robot capability
  • Configuration:
    • Toggle Stream Mode ON
  • Permissions: Add necessary permissions for sending messages
  • Get AppKey (Client ID) and AppSecret (Client Secret) from "Credentials"
  • Publish the app

2. Configure

{
  "channels": {
    "dingtalk": {
      "enabled": true,
      "clientId": "YOUR_APP_KEY",
      "clientSecret": "YOUR_APP_SECRET",
      "allowFrom": []
    }
  }
}

allowFrom: Leave empty to allow all users, or add ["staffId"] to restrict access.

3. Run

nanobot gateway
Slack

Uses Socket Mode โ€” no public URL required.

1. Create a Slack app

  • Go to Slack API โ†’ Create New App โ†’ "From scratch"
  • Pick a name and select your workspace

2. Configure the app

  • Socket Mode: Toggle ON โ†’ Generate an App-Level Token with connections:write scope โ†’ copy it (xapp-...)
  • OAuth & Permissions: Add bot scopes: chat:write, reactions:write, app_mentions:read
  • Event Subscriptions: Toggle ON โ†’ Subscribe to bot events: message.im, message.channels, app_mention โ†’ Save Changes
  • App Home: Scroll to Show Tabs โ†’ Enable Messages Tab โ†’ Check "Allow users to send Slash commands and messages from the messages tab"
  • Install App: Click Install to Workspace โ†’ Authorize โ†’ copy the Bot Token (xoxb-...)

3. Configure nanobot

{
  "channels": {
    "slack": {
      "enabled": true,
      "botToken": "xoxb-...",
      "appToken": "xapp-...",
      "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 policy defaults to open. Set "dm": {"enabled": false} to disable DMs.
Email

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)

  • Create a dedicated Gmail account for your bot (e.g. [email protected])
  • Enable 2-Step Verification โ†’ Create an App Password
  • Use this app password for both IMAP and SMTP

2. Configure

  • consentGranted must be true to allow mailbox access. This is a safety gate โ€” set false to fully disable.
  • allowFrom: Leave empty to accept emails from anyone, or restrict to specific senders.
  • smtpUseTls and smtpUseSsl default to true / false respectively, which is correct for Gmail (port 587 + STARTTLS). No need to set them explicitly.
  • Set "autoReplyEnabled": false if you only want to read/analyze emails without sending automatic replies.
{
  "channels": {
    "email": {
      "enabled": true,
      "consentGranted": true,
      "imapHost": "imap.gmail.com",
      "imapPort": 993,
      "imapUsername": "[email protected]",
      "imapPassword": "your-app-password",
      "smtpHost": "smtp.gmail.com",
      "smtpPort": 587,
      "smtpUsername": "[email protected]",
      "smtpPassword": "your-app-password",
      "fromAddress": "[email protected]",
      "allowFrom": ["[email protected]"]
    }
  }
}

3. Run

nanobot gateway

โš™๏ธ Configuration

Config file: ~/.nanobot/config.json

Providers

Tip

  • Groq provides free voice transcription via Whisper. If configured, Telegram voice messages will be automatically transcribed.
  • Zhipu Coding Plan: If you're on Zhipu's coding plan, set "apiBase": "https://open.bigmodel.cn/api/coding/paas/v4" in your zhipu provider config.
  • MiniMax (Mainland China): If your API key is from MiniMax's mainland China platform (minimaxi.com), set "apiBase": "https://api.minimaxi.com/v1" in your minimax provider config.
Provider Purpose Get API Key
openrouter LLM (recommended, access to all models) openrouter.ai
anthropic LLM (Claude direct) console.anthropic.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.minimax.io
aihubmix LLM (API gateway, access to all models) aihubmix.com
dashscope LLM (Qwen) dashscope.console.aliyun.com
moonshot LLM (Moonshot/Kimi) platform.moonshot.cn
zhipu LLM (Zhipu GLM) open.bigmodel.cn
vllm LLM (local, any OpenAI-compatible server) โ€”
Adding a New Provider (Developer Guide)

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)

Security

For production deployments, set "restrictToWorkspace": true in your config to sandbox the agent.

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.
channels.*.allowFrom [] (allow all) Whitelist of user IDs. Empty = allow everyone; non-empty = only listed users can interact.

CLI Reference

Command Description
nanobot onboard Initialize config & workspace
nanobot agent -m "..." Chat with the agent
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 channels login Link WhatsApp (scan QR)
nanobot channels status Show channel status

Interactive mode exits: exit, quit, /exit, /quit, :q, or Ctrl+D.

Scheduled Tasks (Cron)
# Add a job
nanobot cron add --name "daily" --message "Good morning!" --cron "0 9 * * *"
nanobot cron add --name "hourly" --message "Check status" --every 3600

# List jobs
nanobot cron list

# Remove a job
nanobot cron remove <job_id>

๐Ÿณ Docker

Tip

The -v ~/.nanobot:/root/.nanobot flag mounts your local config directory into the container, so your config and workspace persist across container restarts.

Build and run nanobot in a container:

# 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

๐Ÿ“ Project Structure

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
โ”œโ”€โ”€ bus/            # ๐ŸšŒ Message routing
โ”œโ”€โ”€ cron/           # โฐ Scheduled tasks
โ”œโ”€โ”€ heartbeat/      # ๐Ÿ’“ Proactive wake-up
โ”œโ”€โ”€ providers/      # ๐Ÿค– LLM providers (OpenRouter, etc.)
โ”œโ”€โ”€ session/        # ๐Ÿ’ฌ Conversation sessions
โ”œโ”€โ”€ config/         # โš™๏ธ Configuration
โ””โ”€โ”€ cli/            # ๐Ÿ–ฅ๏ธ Commands

๐Ÿค Contribute & Roadmap

PRs welcome! The codebase is intentionally small and readable. ๐Ÿค—

Roadmap โ€” Pick an item and open a PR!

  • Voice Transcription โ€” Support for Groq Whisper (Issue #13)
  • Multi-modal โ€” See and hear (images, voice, video)
  • Long-term memory โ€” Never forget important context
  • Better reasoning โ€” Multi-step planning and reflection
  • More integrations โ€” Calendar and more
  • Self-improvement โ€” Learn from feedback and mistakes

Contributors

Contributors

โญ Star History

Thanks for visiting โœจ nanobot!

Views

nanobot is for educational, research, and technical exchange purposes only

About

"๐Ÿˆ nanobot: The Ultra-Lightweight OpenClaw"

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 95.4%
  • TypeScript 2.1%
  • Shell 1.9%
  • Other 0.6%