Skip to main content

Control Plane Flow documentation

cpflow brings a Heroku-style, convention-driven workflow to Control Plane: review apps, staging, production promotion, release phases, and the operational commands your team runs every day. Pick the path that matches what you're doing right now.

Get started​

  • Install the CLI — gem install cpflow, then point it at your Control Plane org.
  • Migrate from Heroku — map apps, dynos, add-ons, review apps, staging, and production onto Control Plane workloads.
  • Automate GitHub Flow — generate review-app, staging, and production-promotion workflows that run in GitHub Actions.
  • Generate with AI — use the rollout prompt to scaffold the whole flow with an assistant.

Operate day to day​

  • Secrets and ENV values — manage configuration and secrets across review, staging, and production.
  • DNS setup — point custom domains at Control Plane workloads.
  • Thruster HTTP/2 proxy — run Basecamp's Thruster proxy without the 502 protocol-error traps.
  • Troubleshooting — diagnose the failures teams hit most often.
  • Tips — practical advice for getting more out of cpflow.

Data services​

  • Postgres — migrate a Postgres database off Heroku infrastructure.
  • Redis — migrate Redis instances to Control Plane.

Infrastructure as code​

Reference​

  • Command reference — every cpflow command, flag, and example, generated from the CLI source.
  • Overview (full README) — the complete project guide in one long-form page.
  • Changelog — release notes, breaking changes, and migration notes.
Need a hand?

ShakaCode builds and maintains Control Plane Flow. For migration, architecture, or performance help, book a free 30-minute call with the maintainers.