CLI client contract

Understand how future CLI clients should use the ReleaseMind backend contract.

Updated: Feb 1, 2026

Current status

There is no currently published SI orbit client after the SI orbit extraction.

The /api/cli/** routes remain the backend contract for a future ReleaseMind CLI client.

Dashboard and automation API workflows are the current supported release paths.

Contract boundaries

Future clients should reuse the ReleaseMind browser auth flow, repo linking, runbook gates, billing checks, and publish service.

Automation clients should use repo-scoped tokens and the /api/automation/** endpoints.

If a repo is missing, update the GitHub App installation and resync in Repos.

Release workflow

Create and review interactive releases in Release Studio.

Use automation prepare, status, and publish requests for unattended CI flows.

Record reproducible runbook evidence from commands, dashboard checks, deployment IDs, or release URLs.

Verify the result

Use the dashboard or automation status endpoint to verify the release.

Confirm status is published and the release_url points to /releases/tag/<tag>.

If publishing is rerun, ReleaseMind returns the existing published release state.

Review and introspect

CLI releases should stay as reviewable as dashboard releases.

  • Did you review the notes before publishing?
  • Is the repo linked to the GitHub installation that owns the tags?
  • Are required runbook gates complete with useful evidence?
  • Does the returned release URL point at the expected tag?

Need more help?

Support

Email

Email [email protected] with your org, repo, and release tag for the fastest response.

Email support

Related articles

Automation tokens

Create scoped bearer tokens for CI, scripts, and unattended release runbooks.

Automation API runbook

Use prepare, status, and publish endpoints for unattended release workflows.

Was this article helpful?