# Mogplex Documentation

- [Welcome to Mogplex](/): Choose the right Mogplex starting point, platform area, capability, configuration path, guide, or reference page.

- **Start Here**
- [Quickstart](/quickstart): Set up Mogplex for one repo, pick the right first routing surface, run locally, and verify that work is visible.
- [Plans & Billing](/plans-and-billing): Mogplex plans and billing documentation is coming soon. This page is the stable home for plan, entitlement, usage, invoice, and billing setup docs.
- [Support](/support): Find the right Mogplex troubleshooting path for setup, routing, models, CLI auth, sandboxes, integrations, and docs issues.

- **Product**
- Platform
  - [Platform](/platform): Understand the Mogplex app, CLI, projects, Sandbox compute, Worktree checkouts, headless runs, and hosted API as one platform.
  - [How Mogplex Fits Together](/platform/how-mogplex-fits-together): Understand the Mogplex object model from account state and routing to missions, tasks, Worktrees, Sandbox compute, runs, and observability.
  - [Mogplex App](/platform/app): Use the Mogplex app for setup, routing, Control sessions, Sandbox compute, Worktree checkouts, reusable agents, and inspection.
  - [Mogplex CLI](/platform/cli): Use the Mogplex CLI as a terminal cockpit for repo-local runs, approvals, diffs, MCP, memory, models, cost, and export.
  - [Headless Runs](/platform/headless-runs): Start Mogplex work from scripts, CI, dashboards, or automation without opening the interactive CLI.
  - [Projects, Sandboxes, and Worktrees](/platform/projects-and-sandboxes): Understand how Projects connect repository context to Sandbox compute and task-specific Worktree checkouts in Control.
  - [Hosted API](/platform/hosted-api): Understand when to use the versioned Mogplex API for repositories, agents, models, sandboxes, automations, runs, and MCP.
- Capabilities
  - [Capabilities](/capabilities): Learn the main Mogplex capabilities: agents, automations, triggers, assignments, observability, and reusable agent context.
  - [Agents](/capabilities/agents): Define reusable Mogplex agents with names, slugs, prompts, models, categories, skills, rules, and context.
  - [Routing](/capabilities/routing): Choose between Triggers, Assignments, Automations, GitHub mentions, headless runs, and local CLI execution.
  - [Review and Triage](/capabilities/review-and-triage): Configure Mogplex for pull request review, issue triage, CI failure investigation, GitHub mentions, and follow-up edits.
  - [Observability](/capabilities/observability): Inspect Mogplex run health, pressure, model calls, tool calls, tokens, cost, sandbox linkage, and runtime errors.
- CLI
  - [Overview](/cli): Mogplex CLI is a terminal-native command center for supervising AI coding runs — agents, runs, MCP, memory, diffs, approvals, cost, and model routing on one screen.

  - **Start here**
  - [Installation](/cli/installation): Install the Mogplex CLI on macOS, Linux, or Windows and verify that it is runnable in your shell.
  - [Quickstart](/cli/quickstart): Install, sign in, start a run, and confirm the CLI cockpit is working end-to-end.

  - **Learn**
  - Concepts
    - [Overview](/cli/concepts): The mental model for how the Mogplex CLI works — architecture, transports, permissions, approvals, and attach mode.
    - [Architecture](/cli/concepts/architecture): One-page mental model — transport → dispatcher → store → React, structured events only, no polling.
    - [Transports](/cli/concepts/transports): The three transports the CLI speaks (process, daemon, stdio) and the rules the router uses to pick one.
    - [Permissions](/cli/concepts/permissions): Two-mode permission model — `approval` and `auto` — with global and per-project rules layered on disk.
    - [Approvals](/cli/concepts/approvals): How tool calls get gated, the approval queue, risk levels, and what auto-reject means.
    - [Attach](/cli/concepts/attach): Use `--attach <runId>` to pull up the cockpit for a run that started somewhere else (CI, web app, another shell).
  - Guides
    - [Overview](/cli/guides): Behavioral guides for the Mogplex CLI — auth, configuration, slash workflows, and repo-local conventions.
    - [Authentication](/cli/guides/authentication): In-app login, credential precedence, browser sign-in, account-backed access, and what `/login` and `/logout` actually change.
    - [Configuration and Flags](/cli/guides/configuration-and-flags): Understand CLI launcher flags, environment-variable escape hatches, config.toml layers, and where Mogplex stores local state.
    - [Slash Commands](/cli/guides/slash-commands): Common workflows in the composer — start a run, pause, switch model, view a diff, approve, export.
    - [Project Commands](/cli/guides/project-commands): Use `AGENTS.md`, `agent.json`, custom slash commands, and per-project permission files to make Mogplex behave like part of the repository.
  - Skills
    - [Skills](/cli/skills): Agent Skills that teach external agents (Claude Code, Claude Agent SDK, Cursor, opencode) how to guide a user through the Mogplex CLI cockpit.
    - [using-mogplex-cli](/cli/skills/using-mogplex-cli): Umbrella skill for guiding a user through the Mogplex CLI cockpit when no Mogplex MCP server is available.
    - [mogplex-slash](/cli/skills/mogplex-slash): Recommends the right Mogplex slash command for a user's intent and explains what each command does in the cockpit.
    - [mogplex-auth](/cli/skills/mogplex-auth): Walks the user through the Mogplex CLI's in-app login screen, env-var escape hatches, and credential troubleshooting.

  - **Automation**
  - Automation
    - [Automation](/cli/automation): The Mogplex CLI ships a headless subcommand surface alongside the interactive TUI. Use it for CI runs, dashboards, scheduled jobs, or anywhere a real terminal isn't available.
    - [Headless runs](/cli/automation/headless-runs): Start, inspect, tail, and cancel cloud runs from the terminal without launching the TUI. Idempotency keys are auto-generated and --follow streams events to stdout.
    - [CI integration](/cli/automation/ci-integration): Use mogplex run + runs events --follow from GitHub Actions, GitLab CI, or any CI runner that can hit a public HTTPS endpoint. A worked GitHub Actions example, secret handling, and a retry pattern.

  - **Reference**
  - Reference
    - [Overview](/cli/reference): Reference pages for the CLI cockpit — panels, drawers, keybindings, cost & usage, and export.
    - [Panels](/cli/reference/panels): Every panel in the cockpit — what it shows, when it updates, what it doesn't do.
    - [Drawers](/cli/reference/drawers): Every drawer in the cockpit — what it does, how to open it, when to use it.
    - [Keybindings](/cli/reference/keybindings): Focus rotation, exit behavior, drawer keys, and the Ctrl+C soft-interrupt.
    - [Cost & Usage](/cli/reference/cost-and-usage): How the cockpit tracks tokens, cost, run limits, and surfaces warnings before you hit a wall.
    - [Export](/cli/reference/export): Serialize a run for sharing or archival via `/export` and the Run Export drawer.
  - Commands
    - [Slash Commands](/cli/commands): Every slash command you can type in the Mogplex CLI composer.
- Web App
  - [Overview](/web): Use the Mogplex web app to connect GitHub, import repos, author agents, choose routing, and operate the hosted control plane.

  - **Platform**
  - [Projects](/web/spaces): Use Projects at /spaces to organize repos, launch Sandbox compute, open workspace sessions, and enter Control with the correct repository context.
  - [Sandboxes](/web/sandboxes): Use Sandbox compute for commands and previews, select the correct runtime in Control, and understand Stop or Delete without changing Worktrees.
  - [Worktrees](/web/worktrees): Learn how Mogplex gives each planned task a Git checkout inside selected Sandbox compute.

  - **Capabilities**
  - Agents
    - [Overview](/web/agents): Manage reusable agents, presets, forks, categories, slugs, and the supporting skills, rules, and context libraries.
    - [Roster and Slugs](/web/agents/roster-and-slugs): Understand the reusable agent roster, how presets and customizations behave, and why slugs matter for GitHub mention routing.
    - [Skills, Rules, and Context](/web/agents/skills-rules-context): Learn how Mogplex separates reusable skills, rules, and context so agents stay composable instead of bloated.
  - Automations
    - [Overview](/web/automations): Build multi-step GitHub-triggered workflows with explicit agent roles, mention routing, and publish control.
    - [Agent Roles](/web/automations/agent-roles): Choose the right automation node role for review, edit, and triage work.
    - [Publishing and Routing](/web/automations/publishing-and-routing): Understand how draft graphs, published versions, activation, and webhook routing actually work in Automations.
  - [Triggers](/web/triggers): Route one GitHub webhook event directly to one agent without building a full automation graph.
  - [Assignments](/web/assignments): Bind one repo, one agent, and one standing work type together for repeatable review, triage, CI, and cron-driven work.
  - [Observability](/web/observability): Inspect Mogplex run health, resource selection, Sandbox time, Worktree linkage, model calls, tool calls, and estimated cost.

  - **Configure**
  - [Settings](/web/settings): Manage GitHub identity, App coverage, connections, access tokens, models, account billing state, and shared preferences.
  - [Available Models](/web/models): Browse the Mogplex model catalog snapshot, then learn how defaults and enabled models work and how the web app, CLI, agents, flows, and repos use model access.
  - Installations
    - [Overview](/web/installations): Understand GitHub App installations, how Mogplex maps repos to them, and why installation coverage is different from simple repo visibility.
    - [Coverage and Triggerability](/web/installations/coverage-and-triggerability): Learn why GitHub OAuth is not the same as GitHub App coverage, how Mogplex labels connection state, and what makes a repo actually trigger-ready.
    - [Repo Sync and Rebinding](/web/installations/repo-sync-and-rebinding): Understand how installation-scoped repo sync works, what Mogplex updates or preserves, and when stale trigger or automation bindings can be repaired.

  - **Learn and build**
  - Guides
    - [Overview](/web/guides): Practical operating guides for the Mogplex web app, organized by the setup or routing problem you are actually trying to solve.
    - [Project Workflow](/web/guides/project-workflow): The practical path from GitHub connection to repo import, sandbox launch, and production routing in Mogplex.
    - [Connection Scope and Overrides](/web/guides/connection-scope-and-overrides): Understand when a connection should be global, project-scoped, or explicitly excluded for one repo.
    - [GitHub App Coverage](/web/guides/github-app-coverage): Understand the difference between GitHub OAuth and GitHub App coverage, and verify why a repo is or is not triggerable.
    - [Choose the Right Routing Surface](/web/guides/choose-routing-surface): Decide between Triggers, Assignments, and Automations using the actual source of truth, scope, and prerequisite state.
    - [GitHub Mention Routing](/web/guides/github-mention-routing): Understand bare vs targeted mentions, agent slugs, and how mention routing behaves in Triggers and Automations.
    - [Legacy Routes](/web/guides/legacy-routes): Map older Mogplex dashboard routes like /flows, /library, and /primitives to the current surfaces and docs.
- MCP
  - [MCP](/mcp): Connect local agents to Mogplex with OAuth, then operate repos, sandboxes, automations, models, runs, and logs through hosted MCP tools.
  - [Install Mogplex MCP](/mcp/install): Connect Cursor, Codex, Claude Code, or OpenCode to the hosted Mogplex MCP endpoint and authenticate with OAuth.
  - [MCP tools](/mcp/tools): Reference the repo, env var, sandbox, automation, model, log, and agent-run tools exposed by the Mogplex MCP endpoint.
  - [Automations through MCP](/mcp/automations): Safely create, update, publish, trigger, and inspect Mogplex Flow automations from a local agent.
  - [MCP security](/mcp/security): Understand Mogplex MCP OAuth, PKCE, consent, token validation, client admission, PAT fallback, and authorization scopes.
  - [Troubleshoot MCP](/mcp/troubleshooting): Fix Mogplex MCP installation, OAuth, tool discovery, authorization, and automation request errors.
- Configure & Extend
  - [Configure & Extend](/configure-and-extend): Configure account state, models, billing, repo instructions, custom commands, connections, MCP, permissions, approvals, slash commands, and project rules.
  - [Agent Authoring](/configure-and-extend/agent-authoring): Design durable Mogplex agents with clear jobs, slugs, prompts, models, skills, rules, context, and routing expectations.
  - [Repo Instructions](/configure-and-extend/repo-instructions): Use AGENTS.md, AGENTS.override.md, and agent.json to give Mogplex durable repo-local context without stuffing every run prompt.
  - [Custom Slash Commands](/configure-and-extend/custom-slash-commands): Understand the Mogplex slash-command authoring format, project command paths, template syntax, and the current cockpit registry limitation.
  - [External connections](/configure-and-extend/connections-and-mcp): Configure external REST and MCP connections, understand scope resolution, sync saved server definitions, and distinguish them from the Mogplex MCP endpoint.
- Integrations
  - [Integrations](/integrations): Connect Mogplex to GitHub, Vercel, Slack, CI, the hosted API, MCP clients, and local agent hosts.
  - [GitHub](/integrations/github): Connect Mogplex to GitHub identity, App coverage, repo import, comments, PRs, issues, reviews, triggers, and automations.
  - [Vercel](/integrations/vercel): Configure repo-linked Vercel project metadata, environment sync, and preview troubleshooting for Mogplex.
  - [Slack](/integrations/slack): Install Mogplex in Slack, link channels to repos, control repo-agent runs, and understand DM, thread, and attachment behavior.
- Guides
  - [Guides](/guides): Practical guides for setup, routing, Control execution environments, GitHub coverage, observability, CLI configuration, and recovery.
  - [Common Use Cases](/guides/common-use-cases): Pick the right Mogplex surface for common review, triage, CI, automation, sandbox, CLI, and API workflows.
  - [How to Work With Mogplex](/guides/how-to-work-with-mogplex): Write clearer Mogplex requests for CLI runs, GitHub mentions, assignments, automations, and headless jobs.
  - [GitHub Routing Cookbook](/guides/github-routing-cookbook): Pick concrete Mogplex routing patterns for mentions, PR review, issue triage, CI failure response, scheduled work, and multi-agent workflows.
  - [Sandbox Setup Checklist](/guides/sandbox-setup-checklist): Configure repo, branch, root directory, commands, ports, env, managed access, and preview expectations before debugging sandbox runs.
  - [Control Execution Environments](/guides/control-execution-environments): Choose Sandbox compute or a task Worktree in Control. Learn the exact effect of each lifecycle action.
  - [Model Selection and Cost](/guides/model-selection-and-cost): Choose models deliberately across settings, agents, automations, CLI runs, repo exclusions, and cost observability.
  - [Observability Runbook](/guides/observability-runbook): Trace failed, stuck, expensive, or misrouted work through runs, tools, selected Sandboxes, Worktree checkouts, and API state.
  - [Troubleshooting](/guides/troubleshooting): Debug Mogplex setup, routing, model access, CLI auth, sandbox, API, and observability issues from the surface that owns the state.
- Reference
  - [Reference](/reference): Reference material for the hosted API, CLI cockpit, security and data handling, slash commands, keybindings, panels, drawers, cost reporting, and exports.
  - [API Reference](/reference/api): The complete Mogplex v1 REST contract, including authentication, request types, payloads, response envelopes, errors, repositories, agents, models, sandboxes, automations, runs, and MCP transport.
  - [Glossary](/reference/glossary): Definitions for Mogplex product terms such as agents, runs, projects, installations, triggers, assignments, automations, sandboxes, worktrees, and observability.
  - [Security and Data Handling](/reference/security-and-data-handling): Understand how Mogplex handles identity, tokens, managed model access, connection secrets, webhooks, API events, sandboxes, and support data.