|
| 1 | +# nanobot 🐈 |
| 2 | + |
| 3 | +**nanobot** is an ultra-lightweight, open-source AI agent framework that keeps the |
| 4 | +core agent loop small and readable, while supporting everything you need for a |
| 5 | +practical, 24/7 personal AI assistant. |
| 6 | + |
| 7 | +## What It Does |
| 8 | + |
| 9 | +nanobot routes messages from your favourite chat platforms through a compact agent |
| 10 | +loop: the LLM decides which tools to call, tools execute, and responses stream back |
| 11 | +— all without a heavy orchestration layer. Dream two-phase memory consolidation |
| 12 | +keeps context coherent across long sessions, and a configurable shell sandbox |
| 13 | +ensures safe local execution. |
| 14 | + |
| 15 | +## Key Capabilities |
| 16 | + |
| 17 | +| Capability | Details | |
| 18 | +|---|---| |
| 19 | +| **Chat channels** | Telegram, Discord, Slack, WhatsApp, WeChat, Feishu, Matrix, email, WebSocket, WebUI | |
| 20 | +| **Tools** | Shell (sandboxed), file r/w/edit, web search, URL fetch, MCP servers, image generation, sub-agents | |
| 21 | +| **Memory** | Dream two-phase consolidation — persist and compress history across sessions | |
| 22 | +| **Scheduling** | Natural-language cron reminders and recurring tasks | |
| 23 | +| **Long goals** | `/goal` holds sustained objectives across many turns | |
| 24 | +| **API** | OpenAI-compatible HTTP API (`/v1/chat/completions`) | |
| 25 | +| **Providers** | Anthropic, OpenAI, Azure, AWS Bedrock, DeepSeek, Gemini, Ollama, vLLM, OpenRouter, and more | |
| 26 | + |
| 27 | +## Quick Start |
| 28 | + |
| 29 | +```bash |
| 30 | +pip install nanobot-ai |
| 31 | +nanobot onboard # interactive setup wizard |
| 32 | +nanobot agent # start chatting |
| 33 | +``` |
| 34 | + |
| 35 | +## Links |
| 36 | + |
| 37 | +- **Source**: https://github.com/HKUDS/nanobot |
| 38 | +- **Docs**: https://nanobot.wiki |
| 39 | +- **PyPI**: https://pypi.org/project/nanobot-ai/ |
0 commit comments