Getting Started with nanobot: Quick Start Guide

Deploy your ultra-lightweight AI assistant in minutes

From zero to running: complete nanobot setup in 5 simple steps

nanobot Prerequisites and Requirements

Before starting with the nano bot, ensure your system meets these minimal requirements. The nanobot ai framework is designed to run on virtually any modern system.

Python Version

Required: Python 3.10 or higher

Check your version with python --version or python3 --version. The nanobot is built with modern Python features that require 3.10+.

System Resources

Memory: ~100MB RAM (estimated)

Disk: Minimal storage space

The nano bot is remarkably lightweight. Unlike OpenClaw's ~1GB RAM usage, nanobot ai runs efficiently on low-spec hardware.

LLM API Access

Required: At least one LLM provider

The nanobot needs API access to providers like Anthropic (Claude), OpenAI (GPT), DeepSeek, Google Gemini, or any of the 11+ supported services. Sign up for API keys before installation.

Network Connectivity

Required: Internet connection

The nano bot needs internet for LLM API calls, messaging platforms (Telegram, Discord, etc.), and web access tools. Local-only LLMs via vLLM are also supported.

Operating System Support

Linux: Fully supported (Ubuntu, Debian, Fedora, Arch, etc.)
macOS: Fully supported (Intel and Apple Silicon)
Windows: Fully supported (Windows 10, 11)

The nanobot ai is pure Python and runs on any OS that supports Python 3.10+.

nanobot Installation Methods

Choose your preferred installation method for the nano bot. All three methods provide the same nanobot ai functionality — pick the one that fits your workflow.

Method 1: PyPI (Recommended)

pip install nanobot-ai

Best for: Most users
Stability: Stable releases
Updates: pip install --upgrade nanobot-ai

Install the nanobot from PyPI for the latest stable version.

Method 2: uv Tool (Fastest)

uv tool install nanobot-ai

Best for: Speed enthusiasts
Stability: Same stable releases as PyPI
Speed: Ultra-fast installation

The uv package manager provides blazing-fast installation of the nano bot.

Method 3: From Source (Latest)

git clone https://github.com/HKUDS/nanobot
cd nanobot
pip install -e .

Best for: Developers and contributors
Version: Latest development code
Updates: git pull

Install the nanobot ai directly from GitHub source for cutting-edge features.

Detailed Instructions: See our complete nanobot installation guide for step-by-step directions, troubleshooting, and verification steps.

nanobot Quick Start in 5 Steps

Follow these five steps to get your nano bot up and running. The entire process takes just a few minutes for the nanobot ai setup.

1️⃣

Install nanobot

pip install nanobot-ai

Run the installation command in your terminal. The nano bot package and its dependencies will be installed automatically. Takes about 30 seconds on most systems.

2️⃣

Configure LLM Provider

Set up your LLM API credentials. The nanobot supports 11+ providers including Anthropic (Claude), OpenAI (GPT), DeepSeek, and Google Gemini. Add your API key to the nanobot ai configuration file.

Example providers: OpenRouter, Anthropic, OpenAI, Gemini

3️⃣

Set Up Messaging Platform

Recommended: Telegram

Configure at least one messaging platform for the nano bot. Telegram is recommended for beginners due to its simple setup and full feature support including voice transcription. The nanobot also supports Discord, WhatsApp, Slack, and 5+ other platforms.

4️⃣

Configure Memory System

Set up the nanobot ai memory system. Create a MEMORY.md file for long-term memory and a memory/ directory for daily notes. The nano bot will automatically manage memory context during conversations.

Optional: Customize memory search settings

5️⃣

Run nanobot

nanobot start

Start the nano bot with your configured settings. The nanobot ai will connect to your messaging platforms and LLM provider. You're now ready to have your first conversation!

Your First nanobot Conversation

Once the nano bot is running, start interacting through your configured messaging platform. Here's what you can do with your nanobot ai assistant.

Basic Interaction

Send a message to the nanobot on your platform (e.g., Telegram). The nano bot will respond using your configured LLM provider. Try simple questions like "Hello" or "What can you do?"

Testing Tools

Ask the nanobot ai to perform tool-based tasks: "List files in the current directory" or "What's the current time?". The nano bot will execute file operations, shell commands, or web requests as needed.

Memory Testing

Tell the nanobot something to remember: "My favorite color is blue." Later, ask "What's my favorite color?" to verify the nano bot memory system is working correctly.

Multi-Turn Conversations

Have extended conversations with the nanobot ai. The nano bot maintains context across messages, allowing for natural, flowing dialogue about complex topics.

Example Commands for nanobot

"What platforms do you support?" - Learn about nano bot capabilities
"Read the README.md file" - Test file operations
"Remember that I prefer Python" - Test memory storage
"What programming language do I prefer?" - Test memory recall

Next Steps with nanobot

Now that your nano bot is running, explore advanced features and customization options. The nanobot ai framework offers extensive configuration possibilities.

🌐

Add More Platforms

Connect the nanobot to additional messaging platforms beyond your initial setup. Add Discord, WhatsApp, Slack, Email, or other services. The nano bot can manage all platforms simultaneously from a single instance.

Platform Configuration Guide →

🤖

Configure More LLMs

Add additional LLM providers to your nanobot ai setup. Switch between Anthropic, OpenAI, DeepSeek, Gemini, and others. The nano bot Provider Registry makes this simple.

LLM Provider Guide →

⏰

Set Up Cron Jobs

Configure time-based automation with the nanobot Cron system. Schedule recurring tasks, automated reports, or periodic checks. The nano bot can run 24/7 with autonomous operations.

Cron Configuration →

🛠️

Customize Tools

Extend the nanobot ai tool system with custom capabilities. Add new file operations, shell commands, web integrations, or domain-specific tools. The nano bot architecture makes tool development straightforward.

Tool System Overview →

🧠

Optimize Memory

Fine-tune the nanobot memory system for your use case. Adjust hybrid search weights (vector vs BM25), customize daily note organization, or implement memory consolidation strategies.

Memory System Guide →

📚

Explore Documentation

Read the complete nano bot documentation on DeepWiki and the GitHub repository. Learn about advanced nanobot ai features and best practices.

Common nanobot Setup Issues

Troubleshooting guide for the most common problems when setting up the nano bot. Most nanobot ai issues have simple solutions.

Python Version Error

Problem: "Python 3.10+ required"

Solution: The nanobot requires Python 3.10 or higher. Check your version with python --version. Install Python 3.10+ from python.org or use pyenv to manage versions.

API Key Errors

Problem: "Invalid API key" or authentication failures

Solution: Verify your LLM provider API keys are correct in the nanobot ai configuration. Check for typos, ensure keys have proper permissions, and confirm they're not expired. Test keys directly with the provider's API.

Platform Connection Issues

Problem: Telegram/Discord bot not responding

Solution: Verify bot tokens are correct, check network connectivity, and ensure the nano bot process is running. For Telegram, confirm the bot is not blocked. For Discord, verify bot permissions on the server.

Import Errors

Problem: "ModuleNotFoundError: No module named 'nanobot'"

Solution: The nanobot ai package wasn't installed correctly. Run pip install nanobot-ai again. If using virtual environments, ensure you're in the correct environment. Try pip list | grep nanobot to verify installation.

Memory System Issues

Problem: Memory not persisting or recall failures

Solution: Ensure MEMORY.md and the memory/ directory exist and are writable. Check file permissions. The nano bot needs write access to update memory files during conversations.

Dependencies Conflicts

Problem: Package version conflicts during installation

Solution: Use a fresh virtual environment for the nanobot ai: python -m venv nanobot-env, activate it, then install. This isolates nano bot dependencies from other projects.

Still Having Issues? Report problems on the GitHub Issues page or ask for help in GitHub Discussions. The nanobot community is active and helpful.

You're Ready to Use nanobot!

With your nano bot installed and configured, you're ready to explore the full power of ultra-lightweight AI assistance. Start building, experimenting, and automating with nanobot ai.