ilia/nanobot
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Merge branch 'main' into feature/add-dashscope-support

Browse Source
This commit is contained in:
ZJUCQR 2026-02-03 16:38:32 +08:00
commit 1d258d2369
1 changed files with 13 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -17,7 +17,7 @@
## 📢 News ## 📢 News
- **2025-02-01** 🎉 nanobot launched! Welcome to try 🐈 nanobot! - **2026-02-01** 🎉 nanobot launched! Welcome to try 🐈 nanobot!
## Key Features of nanobot: ## Key Features of nanobot:
@ -60,19 +60,7 @@
## 📦 Install ## 📦 Install
**Install with [uv](https://github.com/astral-sh/uv)** (recommended for speed) **Install from source** (latest features, recommended for development)
```bash
uv tool install nanobot-ai
```
**Install from PyPi**
```bash
pip install nanobot-ai
```
**Install from source** (recommended for development)
```bash ```bash
git clone https://github.com/HKUDS/nanobot.git git clone https://github.com/HKUDS/nanobot.git
@ -80,12 +68,16 @@ cd nanobot
pip install -e . pip install -e .
``` ```
**Install with uv** **Install with [uv](https://github.com/astral-sh/uv)** (stable, fast)
```bash ```bash
uv venv uv tool install nanobot-ai
source .venv/bin/activate ```
uv pip install nanobot-ai
**Install from PyPI** (stable)
```bash
pip install nanobot-ai
``` ```
## 🚀 Quick Start ## 🚀 Quick Start
@ -274,7 +266,6 @@ Config file: `~/.nanobot/config.json`
| `groq` | LLM + **Voice transcription** | Llama, Whisper | [console.groq.com](https://console.groq.com) | | `groq` | LLM + **Voice transcription** | Llama, Whisper | [console.groq.com](https://console.groq.com) |
| `gemini` | LLM (Gemini direct) | `gemini-pro`, `gemini-ultra` | [aistudio.google.com](https://aistudio.google.com) | | `gemini` | LLM (Gemini direct) | `gemini-pro`, `gemini-ultra` | [aistudio.google.com](https://aistudio.google.com) |
> **Note**: Groq provides free voice transcription via Whisper. If configured, Telegram voice messages will be automatically transcribed.
<details> <details>
<summary><b>Full config example</b></summary> <summary><b>Full config example</b></summary>
@ -347,6 +338,9 @@ nanobot cron remove <job_id>
## 🐳 Docker ## 🐳 Docker
> [!TIP]
> The `-v ~/.nanobot:/root/.nanobot` flag mounts your local config directory into the container, so your config and workspace persist across container restarts.
Build and run nanobot in a container: Build and run nanobot in a container:
```bash ```bash
@ -367,8 +361,6 @@ docker run -v ~/.nanobot:/root/.nanobot --rm nanobot agent -m "Hello!"
docker run -v ~/.nanobot:/root/.nanobot --rm nanobot status docker run -v ~/.nanobot:/root/.nanobot --rm nanobot status
``` ```
> **Tip**: Mount `~/.nanobot` so your config and workspace persist across container restarts.
## 📁 Project Structure ## 📁 Project Structure
``` ```