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

update readme

Browse Source
This commit is contained in:
ZJUCQR 2026-02-03 16:28:21 +08:00
parent 8499dbf132
commit 520923eb76
1 changed files with 26 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@ -92,8 +92,7 @@ uv pip install nanobot-ai
> [!TIP] > [!TIP]
> Set your API key in `~/.nanobot/config.json`. > Set your API key in `~/.nanobot/config.json`.
> Get API keys: [OpenRouter](https://openrouter.ai/keys) (LLM) · [Brave Search](https://brave.com/search/api/) (optional, for web search) > Get API keys: [DashScope](https://dashscope.console.aliyun.com) (China) · [OpenRouter](https://openrouter.ai/keys) (Global) · [Brave Search](https://brave.com/search/api/) (optional, for web search)
> You can also change the model to `minimax/minimax-m2` for lower cost.
**1. Initialize** **1. Initialize**
@ -103,6 +102,7 @@ nanobot onboard
**2. Configure** (`~/.nanobot/config.json`) **2. Configure** (`~/.nanobot/config.json`)
For OpenRouter - recommended for global users:
```json ```json
{ {
"providers": { "providers": {
@ -114,9 +114,22 @@ nanobot onboard
"defaults": { "defaults": {
"model": "anthropic/claude-opus-4-5" "model": "anthropic/claude-opus-4-5"
} }
}
}
```
For DashScope - recommended for China users:
```json
{
"providers": {
"dashscope": {
"apiKey": "sk-xxx"
}
}, },
"webSearch": { "agents": {
"apiKey": "BSA-xxx" "defaults": {
"model": "qwen-plus"
}
} }
} }
``` ```
@ -251,13 +264,15 @@ Config file: `~/.nanobot/config.json`
### Providers ### Providers
| Provider | Purpose | Get API Key | | Provider | Purpose | Models | Get API Key |
|----------|---------|-------------| |----------|---------|--------|-------------|
| `openrouter` | LLM (recommended, access to all models) | [openrouter.ai](https://openrouter.ai) | | `dashscope` | LLM (China recommended) | `qwen-turbo`, `qwen-plus`, `qwen-max` | [dashscope.console.aliyun.com](https://dashscope.console.aliyun.com) |
| `anthropic` | LLM (Claude direct) | [console.anthropic.com](https://console.anthropic.com) | | `openrouter` | LLM (access to all models) | All major models | [openrouter.ai](https://openrouter.ai) |
| `openai` | LLM (GPT direct) | [platform.openai.com](https://platform.openai.com) | | `anthropic` | LLM (Claude direct) | `claude-opus-4-5`, `claude-sonnet-4-5` | [console.anthropic.com](https://console.anthropic.com) |
| `groq` | LLM + **Voice transcription** (Whisper) | [console.groq.com](https://console.groq.com) | | `openai` | LLM (GPT direct) | `gpt-4o`, `gpt-4-turbo` | [platform.openai.com](https://platform.openai.com) |
| `gemini` | LLM (Gemini direct) | [aistudio.google.com](https://aistudio.google.com) | | `zhipu` | LLM (China) | `glm-4`, `glm-4-flash` | [open.bigmodel.cn](https://open.bigmodel.cn) |
| `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) |
> **Note**: Groq provides free voice transcription via Whisper. If configured, Telegram voice messages will be automatically transcribed. > **Note**: Groq provides free voice transcription via Whisper. If configured, Telegram voice messages will be automatically transcribed.