nanoinfra Documentation

Use these docs to get a working agent first, then open a task guide only when you need the next capability. Source-level design and extension details are kept in the contributor section.

Repository docs follow the current source tree and can be newer than the latest package release. For published release docs, visit nanoinfra.wiki.

Start Here

Your situation	Read this	You are done when...
Terminals, Python, or API keys are new to you	Beginner walkthrough	The browser can send Hello! and receive a reply
You are comfortable running commands	Install and Quick Start	nanoinfra status is healthy and the WebUI or CLI can get one reply
Something already failed	Troubleshooting	You have isolated the problem to install, config, model, gateway, channel, or tool access

The recommended first-run path is:

1. Install nanoinfra.
2. Let the installer open nanoinfra webui on a fresh local desktop.
3. Configure a provider and model in Settings → Models.
4. Send Hello! before configuring anything else.

Most people do not need to edit JSON for the first run. The WebUI handles the initial provider, model, and local browser settings. SSH, headless, existing-config, and older-release installs retain nanoinfra onboard --wizard as a terminal fallback. After the WebUI opens, use Settings for models and built-in capabilities, Settings → Channels for chat apps, and Apps for CLI App or MCP integrations.

Add One Capability

Pick the row that matches what you want to accomplish next:

Goal	Guide
Learn the browser workbench	WebUI
Connect Telegram, Discord, Slack, Feishu, WeChat, Email, or another chat app	Chat Apps
Choose a hosted, OAuth, company, or local model	Provider Cookbook
Add model fallbacks	Configure Model Fallback
Enable web search	Configure Web Search
Add an MCP tool server	Configure MCP Tools
Generate images	Image Generation
Store credentials and let the agent connect to a server (SSH, Ansible, SSM, API)	Secrets and Servers
Schedule work or create a local trigger	Automations
Understand and manage long-term memory	Memory
Run nanoinfra continuously	Deployment
Run separate bots or workspaces	Multiple Instances
Call nanoinfra from Python	Python SDK
Expose an OpenAI-compatible endpoint	OpenAI-Compatible API

For shorter, outcome-focused walkthroughs, browse the task guide index.

Operate nanoinfra

Need	Read
Commands and flags	CLI Reference
In-chat slash commands	In-Chat Commands
Config, workspace, gateway, sessions, tools, and memory in plain language	Concepts
Provider/model matching and selection	Providers and Models
Setup and runtime diagnosis	Troubleshooting
Older development highlights	Release Archive

Reference

Use reference pages to look up an exact option after you know what you are trying to configure:

Area	Reference
Every configuration field and default	Configuration
Provider and model behavior	Providers and Models
Chat channel prerequisites and manual JSON	Chat Apps
WebSocket authentication and wire protocol	WebSocket
Python SDK classes, events, sessions, and hooks	Python SDK
OpenAI-compatible HTTP routes and payloads	OpenAI-Compatible API
Runtime self-inspection and tuning	My Tool

Configuration examples are usually snippets to merge into ~/.nanoinfra/config.json, not complete replacement files. The docs use camelCase because nanoinfra writes config that way. Keep real API keys, bot tokens, and passwords out of issues and public logs.

Extend or Contribute

These pages explain implementation and extension points. You do not need them to install or operate nanoinfra.

Goal	Read
Understand source ownership and runtime flow	Architecture
Set up a development environment	Development and CONTRIBUTING.md
Add a channel package	Channel Package Guide
Build the WebUI source	WebUI Development

If a command or screen no longer matches these docs, please open an issue with your nanoinfra version, operating system, and the page that needs correction.