Swarmie Documentation

Swarmie is an agentic Rust framework with TUI, CLI oneshot, and web frontends.

Use this site to install, configure, and run Swarmie in local workflows, CI, and multi-agent setups.

Start here

• New user: /getting-started
• First run walkthrough: /getting-started/quickstart
• Auth and provider setup: /getting-started/authentication

Core concepts

• Runtime loop and events: /core-concepts/how-swarmie-works
• Tools and permissions: /core-concepts/tools, /core-concepts/permissions
• Session lifecycle: /core-concepts/sessions
• Modes and context window: /core-concepts/modes, /core-concepts/context-window

Configuration

• Overview and schema: /configuration, /configuration/config-reference
• Provider/agent tuning: /configuration/providers, /configuration/agents
• Integrations: /configuration/mcp, /configuration/hooks, /configuration/skills

Practical guides

• Common workflows: /guides/common-workflows
• Multi-agent and MCP operations: /guides/multi-agent, /guides/mcp-servers
• Automation and serving: /guides/headless-mode, /guides/web-server

Reference

• CLI and slash commands: /reference/cli, /reference/slash-commands
• Keyboard and runtime controls: /reference/keyboard-shortcuts, /reference/thinking-levels
• Env vars and permission responses: /reference/environment-variables, /reference/permission-responses

Need help?

• Troubleshooting guide: /troubleshooting