Documentation

How CaptainCore works, from install to API

Written from the source, not from memory. Start with Getting started if you are installing it, or jump to the CLI and API references if you already run it.

Getting started

Install the Manager and the CLI, connect them, and bring your first site under management.

  • Overview What CaptainCore is, how its two halves divide the work, and who it is built for.
  • Requirements What the Manager, the CLI server and your managed sites each need before you start.
  • Install the Manager Install the WordPress plugin, activate it to create its tables, and point it at your CLI server.
  • Install the CLI Install the Go binary and the runtime scripts, fill in config.json, and connect the CLI to your Manager.
  • Connect your first site Add a site in the dashboard, get it to the CLI, and run the first sync.
  • How updates work How the Manager updates itself, how you update the CLI, and how to check what version each is running.
Concepts

How the two halves fit together and what the words mean.

  • Architecture The exact contract between the Manager and the CLI, including the single callback endpoint and its command ladder.
  • Glossary One-line definitions for the nouns CaptainCore uses across the dashboard, the API and the CLI.
Manager

A tour of the dashboard, screen by screen, plus the wp captaincore commands.

  • Dashboard Tour How the /account dashboard shell is laid out, and the palette, menus and shortcuts that move you through it.
  • Sites Browse and filter the fleet, act on many sites at once, and add or retire a site.
  • Site Detail Every tab on a single site, from credentials and inventory through quicksaves, backups and logs.
  • Domains and DNS The domains list, the staged DNS zone editor, registrar controls, email forwarding and Mailgun sending.
  • Accounts and Billing Accounts, access levels and invites, plan and usage pricing, invoices and payment methods.
  • Security Fleet vulnerabilities, checksum failures, audit coverage, core-update runs and stored site audits.
  • Operations The terminal dock and jobs, the activity log, reports, archives, fleet users, your profile and settings.
  • WP-CLI Commands Every wp captaincore command the Manager registers, what it does and how to run it.
CLI

Every command and remote script, with flags and examples.

  • CLI Overview What the CaptainCore CLI is, where it runs, how you address a site, and the global flags every command accepts.
  • Sites and Data Commands for listing sites, syncing site data, collecting usage and stats, capturing screenshots and reporting version drift.
  • Backups and History Restic backups, git-based quicksaves, downloadable snapshots, archives, visual captures and update logs.
  • Running Commands How to run SSH commands, scripts, recipes and updates against one site or the whole fleet, and how bulk concurrency works.
  • Monitoring and Health Uptime checks, performance sampling, JavaScript error scans, email deliverability checks, server logs and SSH connection verification.
  • Providers, Accounts and the Server Connecting the CLI to a CaptainCore Manager site, managing hosting providers and accounts, reading configuration, and running the HTTP server the Manager dispatches through.
  • Remote Scripts What remote scripts are, how they are piped over SSH, and a catalogue of every script that ships in lib/remote-scripts.
  • Cron and Scheduling How recurring fleet work is defined and scheduled across the CLI and the CaptainCore Manager plugin.
API

The REST API the dashboard uses, and the contract the CLI posts to.

  • Authentication How to authenticate against the CaptainCore REST API with application passwords, how the dashboard authenticates, and what non-admin scoping means.
  • Running commands and jobs Execute WP-CLI and shell code across environments, choose between synchronous and queued execution, then poll, stream or cancel the resulting job.
  • Sites and environments Read and manage sites, their production and staging environments, files, domains, admin tools, stats, performance samples and logs.
  • Domains, DNS and accounts Manage domains and their DNS zones, registrar settings, email forwarding and Mailgun sending, plus accounts, users, invites and billing.
  • Security and operations Fleet security operations, threat tracking and patches, checksum failures, site audits, activity logs, reports, archives, recipes, providers and settings.
  • CLI ingest contract The token-authenticated POST /api endpoint the CaptainCore CLI posts to, every command it accepts, and the key:value format the remote data collector returns.
  • Endpoint index Every route registered under captaincore/v1, with its methods and permission requirement, grouped by area.
Reference

Tables, integrations and the activity log.

  • Data model Every custom table CaptainCore creates, what it holds, how model classes map to tables, and how schema migrations run.
  • Integrations Every hosting, registrar, DNS, email and analytics integration CaptainCore ships with, what credentials each one needs, and what it unlocks.
  • Activity log What CaptainCore records in its audit trail, the shape of a log row, and every action and entity type currently written.