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	Python SDK
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
• embed the agent with the Python SDK
• 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, 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 and recovery for your installation method, backup steps and restart checks.

Track	Install with	Update with	What runs
Stable	installer, uv, or pip	managed installer: WebUI update; other installs: original package tool	one released Python/WebUI/TUI version
Current source	editable Git checkout	git pull --ff-only + editable dependency sync	Python, WebUI, and TUI from that checkout

Stable release: automatic setup (recommended)

The installer chooses an isolated Python environment and opens setup for you. The two commands below are the same installation method for different operating systems; run only the one for your system.

curl -fsSL https://raw.githubusercontent.com/HKUDS/nanobot/main/scripts/install.sh | sh

irm https://raw.githubusercontent.com/HKUDS/nanobot/main/scripts/install.ps1 | iex

The default command installs or upgrades the stable PyPI release. Fresh installations use a dedicated environment under ~/.nanobot/venv. On a fresh local desktop it opens the WebUI for model setup. That gateway keeps running after the browser or terminal closes; use the printed gateway stop command to stop it. SSH, headless, existing-config and older-release installs use terminal setup.

Existing installations keep their package manager, extras and constraints. An active ordinary venv remains an explicit target, not an installer-managed environment. The installer avoids system-wide pip and prints the command to reuse if nanobot is not on PATH.

To preview the plan without changing your environment, pass --dry-run.

curl -fsSL https://raw.githubusercontent.com/HKUDS/nanobot/main/scripts/install.sh | sh -s -- --dry-run

& ([scriptblock]::Create((irm https://raw.githubusercontent.com/HKUDS/nanobot/main/scripts/install.ps1))) --dry-run

If you prefer to inspect the script first, open scripts/install.sh or scripts/install.ps1.

Use this instead of the recommended installer when you already manage your own Python environment. These commands install the same stable nanobot-ai package; they do not launch setup.

uv: isolated CLI installation

uv tool install nanobot-ai

pip: activate your virtual environment first

python -m pip install nanobot-ai

This is the beginning of the README. Read the rest at the original. Read the full README ↗