mirror of
https://github.com/HKUDS/nanobot.git
synced 2026-05-19 16:12:30 +00:00
0bc42e2ab2
- Restrict fallback_models to only reference preset names in model_presets. - Add schema validation to reject unknown preset names in fallback_models. - Remove build_provider_for_model() since bare model fallback is no longer supported. - Simplify make_provider_factory() to only look up presets by name. - Update onboard UI to remove "Add custom model" option from fallback chain. - Update tests to use preset names instead of bare model strings in fallback chains. - Fix test imports referencing deleted _make_provider function.
107 lines
2.2 KiB
Markdown
107 lines
2.2 KiB
Markdown
# Install and Quick Start
|
|
|
|
## Install
|
|
|
|
> [!IMPORTANT]
|
|
> This README may describe features that are available first in the latest source code.
|
|
> If you want the newest features and experiments, install from source.
|
|
> If you want the most stable day-to-day experience, install from PyPI or with `uv`.
|
|
|
|
**Install from source** (latest features, experimental changes may land here first; recommended for development)
|
|
|
|
```bash
|
|
git clone https://github.com/HKUDS/nanobot.git
|
|
cd nanobot
|
|
pip install -e .
|
|
```
|
|
|
|
**Install with [uv](https://github.com/astral-sh/uv)** (stable release, fast)
|
|
|
|
```bash
|
|
uv tool install nanobot-ai
|
|
```
|
|
|
|
**Install from PyPI** (stable release)
|
|
|
|
```bash
|
|
pip install nanobot-ai
|
|
```
|
|
|
|
### Update to latest version
|
|
|
|
**PyPI / pip**
|
|
|
|
```bash
|
|
pip install -U nanobot-ai
|
|
nanobot --version
|
|
```
|
|
|
|
**uv**
|
|
|
|
```bash
|
|
uv tool upgrade nanobot-ai
|
|
nanobot --version
|
|
```
|
|
|
|
**Using WhatsApp?** Rebuild the local bridge after upgrading:
|
|
|
|
```bash
|
|
rm -rf ~/.nanobot/bridge
|
|
nanobot channels login whatsapp
|
|
```
|
|
|
|
## Quick Start
|
|
|
|
> [!TIP]
|
|
> Set your API key in `~/.nanobot/config.json`.
|
|
> Get API keys: [OpenRouter](https://openrouter.ai/keys) (Global)
|
|
>
|
|
> For other LLM providers, please see [`configuration.md`](./configuration.md).
|
|
>
|
|
> For web search capability setup, please see the web-search section in [`configuration.md`](./configuration.md#web-search).
|
|
|
|
**1. Initialize**
|
|
|
|
```bash
|
|
nanobot onboard
|
|
```
|
|
|
|
Use `nanobot onboard --wizard` if you want the interactive setup wizard.
|
|
|
|
**2. Configure** (`~/.nanobot/config.json`)
|
|
|
|
Configure these **two parts** in your config (other options have defaults).
|
|
|
|
*Set your API key* (e.g. OpenRouter, recommended for global users):
|
|
```json
|
|
{
|
|
"providers": {
|
|
"openrouter": {
|
|
"apiKey": "sk-or-v1-xxx"
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
*Set your model* (optionally pin a provider — defaults to auto-detection):
|
|
```json
|
|
{
|
|
"agents": {
|
|
"defaults": {
|
|
"model": "anthropic/claude-opus-4-5",
|
|
"provider": "openrouter"
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
*Want to switch models mid-conversation?* Define [`modelPresets`](./configuration.md#model-presets) and switch instantly with `my(action="set", key="model_preset", value="fast")`.
|
|
|
|
**3. Chat**
|
|
|
|
```bash
|
|
nanobot agent
|
|
```
|
|
|
|
That's it! You have a working AI agent in 2 minutes.
|