# Solo Documentation

Use these Markdown docs to understand Solo features, workflows, and MCP tools.

Search published documentation with `GET /api/v1/docs/search?q={query}&limit={1-50}`. The JSON response contains ranked results with excerpts and Markdown page URLs; `limit` defaults to 10.

## Sections

- [Getting started](/api/v1/docs/getting-started) - Install Solo, learn the interface, and get your first project running.
- [Projects](/api/v1/docs/projects) - Create projects, load repositories, sync solo.yml, and customize project behavior.
- [Workspaces](/api/v1/docs/workspaces) - Group projects into workspaces, switch between them, and spread work across windows.
- [Commands](/api/v1/docs/commands) - Manage command lifecycle, restart behavior, trust, and process states.
- [Agents](/api/v1/docs/agents) - Configure agent tools, launch sessions, and understand agent workflows inside Solo.
- [MCP tools](/api/v1/docs/mcp-tools) - Reference Solo MCP tool groups for projects, processes, output, agents, coordination, and feature tools.
- [Workflows](/api/v1/docs/workflows) - Use Solo surfaces together for daily operations, durable context, and agent handoffs.
- [Todos](/api/v1/docs/todos) - Track project tasks, blockers, comments, and agent coordination through shared todos.
- [Scratchpads](/api/v1/docs/scratchpads) - Capture project notes, Markdown scratchpads, imports, exports, and agent-shared context.
- [Prompt templates](/api/v1/docs/prompt-templates) - Save reusable prompts with placeholders and insert them into agents and terminals.
- [Terminal](/api/v1/docs/terminal) - Search, focus, control mouse input, resume, reattach, and understand terminal-specific behavior.
- [Sidebar](/api/v1/docs/sidebar) - Navigate sections, filter projects, and understand what Solo surfaces in the sidebar.
- [Activity](/api/v1/docs/activity) - Inspect running work, subprocesses, CPU, memory, ports, and process kill controls.
- [Keyboard shortcuts](/api/v1/docs/keyboard-shortcuts) - Default shortcuts, scope rules, project switching, and custom keymaps.
- [Notifications](/api/v1/docs/notifications) - Native notifications, in-app toasts, indicators, bells, and script-triggered alerts.
- [Environment](/api/v1/docs/environment) - Understand PATH loading, shell capture, and version-manager behavior.
- [Integrations](/api/v1/docs/integrations) - Connect Solo to MCP clients, the local HTTP API, and deep links.
- [CLI](/api/v1/docs/cli) - Control Solo from your shell with the solo command-line companion.
- [Settings](/api/v1/docs/settings) - Adjust app settings, tools, terminals, editors, and sidebar preferences.
- [Appearance](/api/v1/docs/appearance) - Theme modes, fonts, and display scale controls.
- [Updates](/api/v1/docs/updates) - Install updates safely and understand what Solo preserves on restart.
- [Account](/api/v1/docs/account) - Licensing, team seats, moving devices, free-tier limits, and common account errors.
- [Troubleshooting](/api/v1/docs/troubleshooting) - Fix PATH issues, notifications, stuck settings, and reporting problems.
- [Command palette](/api/v1/docs/command-palette) - Use the command palette, native menus, and tab picker more effectively.

## Featured Pages

- [Installation and system requirements](/api/v1/docs/getting-started/installation) - Solo is a native desktop app. Current public builds are packaged for macOS and Windows.
- [First launch](/api/v1/docs/getting-started/first-launch) - When you open Solo for the first time, it normally initializes your local app data, license state, settings, and project list before showing the main window. If initialization fail…
- [solo.yml overview](/api/v1/docs/projects/solo-yml) - At the top level, solo.yml can include:
- [Auto-restart](/api/v1/docs/commands/auto-restart) - Auto-restart relaunches a command after it exits unexpectedly.
- [What are agents?](/api/v1/docs/agents/what-are-agents) - Agents in Solo are AI coding tools that you configure in Settings → Agents and launch inside a project. Regular commands stream terminal output and can also accept terminal input.…
- [Agent orchestration workflow](/api/v1/docs/workflows/agent-orchestration) - Solo lets one lead agent coordinate several worker agents in the same project. Treat the lead agent as the orchestrator: it interviews you, writes the plan, creates todos, dispatch…
- [Daily operating patterns](/api/v1/docs/workflows/daily-operating-patterns) - Solo is built for days where you are carrying several projects, local services, terminals, and agents at once. Use the sidebar to see the state of your work, the command palette to…
- [MCP server integration](/api/v1/docs/integrations/mcp-server) - Solo gives MCP clients a local stdio connection to the running app. Compatible clients launch Solo's bundled mcp helper, and Solo handles the private local transport behind the sce…
- [Commands can't find tools (PATH issues)](/api/v1/docs/troubleshooting/path-issues) - Solo's managed commands receive an effective launch environment assembled from shell capture and command-configured variables. On Unix-like systems, Solo captures the login-shell e…

---

Are you a human? Read this doc on the web: https://soloterm.com/docs