README

English |
    简体中文 |
    繁體中文 |
    Español |
    Français |
    Bahasa Indonesia |
    日本語 |
    한국어 |
    Русский |
    Tiếng Việt
  
  
    
    
    
    
    
    
    
  
  
    Discord ·
    X ·
    WeChat 微信交流群 ·
    Feishu
  


 nanobot

🐈 nanobot is an ultra-lightweight, open-source, self-hosted personal AI agent framework written in Python. Use it in a browser, terminal, or chat app to work with files, remember preferences, and schedule tasks. Connect a supported model provider or local model server to supply the AI.

 Start Here

| You want to... | Go to |
|---|---|
| Install nanobot with no terminal/config background | Start Without Technical Background |
| Install quickly and get your first reply | Install and Quick Start |
| Open the bundled browser UI | WebUI |
| Connect Telegram, Discord, WeChat, Slack, Email, Mattermost, Linear, or another channel | Chat app guide |
| Configure providers, fallback models, Langfuse, MCP, web tools, or security | Docs and Configuration |
| Develop the browser UI | Install current source, then WebUI development and Contributing |
| Integrate from Python or HTTP | Python SDK or Agent API |
| Understand or extend the internals | Architecture, Contributing, and Provider extensions |
| Deploy to the cloud or keep nanobot running as a service | Deployment |

 What can nanobot do?

nanobot can:

- run in a browser WebUI or terminal
- connect to Telegram, Discord, Slack, WeChat, Email, Mattermost, Linear, and other channels
- read PDF, Word (.docx), Excel (.xlsx), and PowerPoint (.pptx) files with built-in file tools, for tasks such as summarizing reports
- use shell, web search/fetch, MCP integrations, cron, image generation, and multi-agent delegation
- keep session history and long-term memory through Dream
- run long-horizon goals and scheduled automations
- expose a Python SDK and OpenAI-compatible API for integrations
- deploy as a long-running local or server-side agent gateway

 💡 Why nanobot

- Persistent workflows: keep saved conversations, long-term memory, and task results for later work.
- Chat-native reach: WebUI, API, Telegram, Feishu, Slack, Discord, Teams, email, Mattermost, and Linear.
- Model freedom: OpenAI-compatible APIs, local LLMs, image generation, search, and fallbacks.
- Small core: readable internals with MCP, memory, deployment, and automation built in.
- Own your stack: inspect, customize, self-host, and extend without a giant platform.

 📦 Install

You need Python 3.11 or newer and access to a supported model provider or local model server. Model fees or local hardware requirements depend on the service you choose; nanobot does not supply a model account.

Choose the stable release for everyday use or current source for development and the latest features. This README describes current source; published documentation covers the released version.

New to terminals or model credentials? Follow Start Without Technical Background. Updating an existing instance? Follow updates an

Top issues

Discussions

Latest release

Changes

- Fix TLS certificate verification, sandboxed shell execution and workspace permissions for queued inputs.
- Keep idle maintenance from blocking active work or incorrectly refusing an update. Improve retry, reconnection and recovery behavior, and preserve native provider state through compaction.
- Add a file-context graph with file previews, local Markdown links and recent context snapshots. Switching topics keeps each conversation's context separate.
- Share syntax highlighting across code, source previews and read-only diffs, with complete source copying and plain-text fallbacks.
-