nanobot-rs

中文文档: README.md

Ultra-Lightweight Personal AI Assistant, Rust Edition

nanobot-rs is the Rust version of HKUDS/nanobot, keeping the same ultra-lightweight agent philosophy and tool-driven workflow.

• Rust rewrite for stronger concurrency stability and cleaner deployment ergonomics
• Already integrated by open-vibe/open-vibe as its Rust implementation of nanobot
• Evolving as one of the core runtimes for open-vibe

Open Vibe Integration

• Current Open Vibe integration focus: DingTalk stream bridge + relay workflow into Open Vibe threads

Features

• Agent loop: LLM calls, tool execution, session context, and error handling
• Config system: ~/.nanobot/config.json with provider auto-matching
• Session and memory: JSONL session persistence + memory/MEMORY.md
• Tooling:
  • read_file / write_file / edit_file / list_dir
  • exec
  • web_search / web_fetch
  • message / spawn / cron
• Scheduling and heartbeat:
  • CronService (add/list/remove/enable/run + persistence)
  • HeartbeatService
• Multi-channel support:
  • Telegram (long polling, media download, voice transcription)
  • Discord (Gateway + REST, with typing indicator)
  • WhatsApp (Node bridge)
  • Feishu (REST send; optional WebSocket receive feature)
  • DingTalk (optional Stream receive feature)
  • Email (IMAP inbound + SMTP outbound, explicit consent required)
  • Slack (Socket Mode)
  • QQ (optional feature qq-botrs)
• Built-in skills synced from the original project (skills/*)

Requirements

• Rust stable (recommended 1.85+)
• Optional:
  • Node.js 18+ (for WhatsApp bridge login)
  • Brave Search API key (web_search)
  • Groq API key (audio transcription)

Quick Start

1. Initialize

cargo run -- onboard

2. Configure API key

Edit ~/.nanobot/config.json:

{
  "providers": {
    "openai": {
      "apiKey": "sk-xxx"
    },
    "openrouter": {
      "apiKey": "sk-or-xxx",
      "extraHeaders": {
        "HTTP-Referer": "https://example.com",
        "X-Title": "nanobot-rs"
      }
    }
  },
  "agents": {
    "defaults": {
      "model": "gpt-4o-mini"
    }
  }
}

If you use DingTalk, add this under channels:

{
  "channels": {
    "dingtalk": {
      "enabled": true,
      "clientId": "dingxxx",
      "clientSecret": "secretxxx",
      "allowFrom": []
    }
  }
}

If you use the Email channel (IMAP + SMTP):

{
  "channels": {
    "email": {
      "enabled": true,
      "consentGranted": true,
      "imapHost": "imap.gmail.com",
      "imapPort": 993,
      "imapUsername": "you@gmail.com",
      "imapPassword": "app-password",
      "smtpHost": "smtp.gmail.com",
      "smtpPort": 587,
      "smtpUsername": "you@gmail.com",
      "smtpPassword": "app-password",
      "smtpUseTls": true,
      "fromAddress": "you@gmail.com",
      "allowFrom": ["trusted@example.com"]
    }
  }
}

If you use the Slack channel (Socket Mode):

{
  "channels": {
    "slack": {
      "enabled": true,
      "mode": "socket",
      "botToken": "xoxb-...",
      "appToken": "xapp-...",
      "groupPolicy": "mention",
      "groupAllowFrom": [],
      "dm": {
        "enabled": true,
        "policy": "open",
        "allowFrom": []
      }
    }
  }
}

If you use the QQ channel (currently direct/private chat only):

{
  "channels": {
    "qq": {
      "enabled": true,
      "appId": "your-app-id",
      "secret": "your-secret",
      "allowFrom": []
    }
  }
}

3. Chat directly

cargo run -- agent -m "Hello"

4. Start gateway

cargo run -- gateway

Common Commands

# Status and version
cargo run -- status
cargo run -- version

# Interactive mode
cargo run -- agent

# Channels
cargo run -- channels status
cargo run -- channels login

# Cron jobs
cargo run -- cron list
cargo run -- cron add -n daily -m "Good morning" --cron "0 9 * * *"
cargo run -- cron enable <job_id>
cargo run -- cron run <job_id>
cargo run -- cron remove <job_id>

Interactive exit commands: exit, quit, /exit, /quit, :q, or Ctrl+C/Ctrl+D.

Feishu WebSocket Receive

Default build supports Feishu sending. To enable Feishu WebSocket receive:

cargo run --features feishu-websocket -- gateway

DingTalk Stream Receive

Default builds do not include DingTalk Stream. Enable it with:

cargo run --features dingtalk-stream -- gateway

QQ Channel (Direct/Private Chat Only)

QQ support is disabled by default; enable it via the qq-botrs feature.

1. Register and create a bot

• Go to QQ Open Platform, register as a developer, and create a bot app
• Copy AppID and AppSecret from Developer Settings

2. Configure sandbox for testing

• Open sandbox settings in the bot console
• Add your QQ account as a test member
• Scan the bot QR code with mobile QQ and start a direct chat

3. Configure ~/.nanobot/config.json

• Use the qq snippet above with appId and secret
• Leave allowFrom empty for open access, or set allowed user openids from logs

4. Start gateway

cargo run --features qq-botrs -- gateway

After startup, send a direct QQ message to the bot and it should reply.

WhatsApp Login

channels login will automatically:

• Prepare ~/.nanobot/bridge
• Run npm install
• Run npm run build
• Start bridge and print QR login flow in terminal

Development

cargo fmt
cargo test
cargo check --features feishu-websocket
cargo check --features dingtalk-stream
cargo check --features qq-botrs

License

MIT