Skip to content

Getting Started

This section takes you from an empty folder to a readiness-proven agent. Bare mono-agent init on a TTY names the agent, searches the provider catalogs, and runs a real no-tool check for every selected route before the strict full Agent ready gate; flag/non-TTY init creates a scaffold only. mono-agent remains config-first: one mono-agent.config.json, driven by the CLI.

  1. Install — get the published CLI or build the source CLI.
  2. Quickstart — run guided init, understand catalog/auth/route verification and the full-agent gate, then smoke-test the ready webhook agent.
  3. Concepts — understand the moving parts so the rest of the docs make sense.
PageWhat it covers
InstallInstall the mono-agent CLI, scaffold a new project with mono-agent init, and confirm your toolchain is ready.
QuickstartScaffold a minimal mono-agent.config.json, validate it, and run your first agent turn when model auth is available.
ConceptsThe core model — agent, runtime, channels, tools, memory, and context — and how config maps onto them.

Once your agent runs, branch out by topic:

  • Configuration — the full annotated config blueprint, environment variables, and folder layout.
  • Runtime — Pi runtime & model references, fallback chains, sessions, and execution effort.
  • Channels — connect Telegram, Slack, WhatsApp, webhooks, the OpenAI-compatible API, A2A, and cron.
  • Always-on web console — keep multiple browser conversations with auto-discovered local agents over a trusted LAN or tailnet.
  • Programmatic — for capabilities that are code-only rather than config-driven.