# Swarmie Docs

> Swarmie documentation site

## Docs

- [Troubleshooting](/troubleshooting): This page is grounded in:
- [CLI Reference](/reference/cli): This page is grounded in `crates/cli/src/cli.rs`.
- [Environment Variables](/reference/environment-variables): This page is grounded in:
- [Keyboard Shortcuts](/reference/keyboard-shortcuts): Keyboard handling source: `crates/tui/src/app/update/keys.rs`.
- [Permission Responses](/reference/permission-responses): This page is grounded in:
- [Slash Commands](/reference/slash-commands): Swarmie parses slash commands in `crates/tui/src/input/slash.rs`.
- [Thinking Levels](/reference/thinking-levels): This page is grounded in:
- [Common Workflows](/guides/common-workflows): Start Swarmie in project root:
- [Custom Modes](/guides/custom-modes): Custom modes extend built-in `default` and `plan` behavior with your own instructions and tool policies.
- [Headless Mode](/guides/headless-mode): Use `swarmie prompt` for non-interactive runs in scripts, CI, and automation.
- [MCP Servers](/guides/mcp-servers): Swarmie supports MCP transports over `stdio`, `http`, and `sse`.
- [Multi-Agent](/guides/multi-agent): Swarmie multi-agent orchestration is implemented in core tooling and surfaced in the TUI.
- [Project Instructions](/guides/project-instructions): Swarmie supports repository-scoped instructions through `AGENTS.md`.
- [Web Server](/guides/web-server): Use `swarmie web` to run the HTTP frontend (REST + SSE).
- [Authentication](/getting-started/authentication): Swarmie supports OAuth and API-key authentication. The recommended starting flow is `/connect` inside the TUI.
- [Installation](/getting-started): Swarmie ships as the `swarmie` binary from the `crates/cli` crate.
- [Quickstart](/getting-started/quickstart): This guide gets you from first launch to your first completed turn.
- [Context Window](/core-concepts/context-window): Context usage is tracked by `ContextWindowTracker` (`crates/core/src/context_window.rs`) and emitted to frontends via `Event::ContextUpdate` (`crates/protocol/src/protocol.rs`).
- [How Swarmie Works](/core-concepts/how-swarmie-works): Swarmie is event-driven: frontends send `Op` messages to core, and core emits `Event` messages back.
- [Modes](/core-concepts/modes): Modes are behavioral presets that inject developer instructions and can adjust permissions/tool visibility.
- [Permissions](/core-concepts/permissions): Swarmie uses rule-based permission evaluation with trust presets.
- [Sessions](/core-concepts/sessions): Session lifecycle operations are protocol-level `Op` variants (`crates/protocol/src/protocol.rs`) and are handled in core session handlers (`crates/core/src/handlers/session.rs`, `crates/core/src/handlers/mode.rs`).
- [Built-in Tools](/core-concepts/tools): Swarmie registers its built-in tools in `crates/tools/src/registry.rs` via `core_registry()`.
- [Agents](/configuration/agents): Per-agent profiles are configured under `[agents.<name>]` in `config.toml`.
- [Budget](/configuration/budget): Swarmie budget settings come from `[budget]` in `config.toml` (`crates/core/src/config/toml_types.rs`) and are enforced per session by `BudgetEvaluator` (`crates/core/src/budget/evaluator.rs`).
- [Config Reference](/configuration/config-reference): This reference maps directly to `crates/core/src/config/toml_types.rs`.
- [Hooks](/configuration/hooks): Swarmie hooks attach custom handlers to lifecycle events.
- [Config Overview](/configuration): Swarmie loads layered TOML configuration and merges it into one runtime config.
- [MCP](/configuration/mcp): Swarmie supports Model Context Protocol servers with `stdio`, `http`, and `sse` transports.
- [Providers](/configuration/providers): Swarmie provider configuration is defined in `crates/core/src/config/toml_types.rs` and resolved at runtime in `crates/core/src/config/resolve.rs`.
- [Sandbox](/configuration/sandbox): Swarmie sandbox config lives under `[sandbox]` in `config.toml` (`crates/core/src/config/toml_types.rs`) and is resolved into `SandboxConfig` (`crates/core/src/config/types.rs`).
- [Skills](/configuration/skills): Skills are Markdown files with optional YAML frontmatter parsed by `crates/core/src/skills/frontmatter.rs`.
- [Themes](/configuration/themes): TUI theming is implemented in `crates/tui/src/theme/theme.rs` with terminal palette support in `crates/tui/src/theme/terminal.rs`.
- [WASM Tools](/configuration/wasm-tools): Swarmie defines WASM tool configuration under `[wasm_tools.<name>]` in TOML (`crates/core/src/config/toml_types.rs`). Runtime structures are in `crates/core/src/config/types.rs` and execution limits are in `crates/wasm/src/limits.rs`.