| 1 | # Framework Reference |
| 2 | |
| 3 | Echo Director Agent is built on nanobot. This directory contains general reference material for the |
| 4 | underlying framework. For Echo Director installation, video workflows, model routing, and file-storage |
| 5 | configuration, start with the root [`README.md`](../README.md) and |
| 6 | [`.config.local.example.json`](../.config.local.example.json). Upstream framework documentation is |
| 7 | available at [nanobot.wiki](https://nanobot.wiki/docs/latest/getting-started/nanobot-overview). |
| 8 | |
| 9 | ## Core Docs |
| 10 | |
| 11 | Start here for setup and everyday usage. |
| 12 | |
| 13 | | Topic | Repo docs | What it covers | |
| 14 | |---|---|---| |
| 15 | | Configuration | [`configuration.md`](./configuration.md) | Providers, tools, channels, MCP, and runtime settings | |
| 16 | | Multiple instances | [`multiple-instances.md`](./multiple-instances.md) | Run isolated bots with separate configs and workspaces | |
| 17 | | CLI reference | [`cli-reference.md`](./cli-reference.md) | Core CLI commands and common entrypoints | |
| 18 | | In-chat commands | [`chat-commands.md`](./chat-commands.md) | Slash commands and periodic task behavior | |
| 19 | | OpenAI-compatible API | [`openai-api.md`](./openai-api.md) | Local API endpoints, request format, and file uploads | |
| 20 | |
| 21 | ## Advanced Docs |
| 22 | |
| 23 | Use these when you want deeper customization, integration, or extension details. |
| 24 | |
| 25 | | Topic | Repo docs | What it covers | |
| 26 | |---|---|---| |
| 27 | | Memory | [`memory.md`](./memory.md) | How nanobot stores, consolidates, and restores memory | |
| 28 | | Python SDK | [`python-sdk.md`](./python-sdk.md) | Use nanobot programmatically from Python | |
| 29 | | Channel plugin guide | [`channel-plugin-guide.md`](./channel-plugin-guide.md) | Build and test custom chat channel plugins | |
| 30 | | WebSocket channel | [`websocket.md`](./websocket.md) | Real-time WebSocket access and protocol details | |
| 31 | | Custom tools | [`my-tool.md`](./my-tool.md) | Inspect and tune runtime state with the `my` tool | |
| 32 |