CLI Release Distribution API

CoffeeBreakAI publishes CLI distribution metadata through public, unauthenticated endpoints so the UI, installers, and automation tools can stay aligned with the same release manifest.

Endpoints

Endpoint	Description
`GET /cli/releases/channels`	Lists the configured release channels (for example, `stable`, `beta`, `latest`).
`GET /cli/releases`	Returns the latest release manifest for the default channel. Optional `platform` filter.
`GET /cli/releases/{channel}`	Returns the latest release manifest for a specific channel. Optional `platform` filter.
`GET /cli/releases/history`	Returns recent releases across channels. Optional `platform`, `take`, and `channel` filters.
`GET /cli/releases/compatibility`	Evaluates a CLI version against the default channel. Requires `currentVersion`; optional `platform`.
`GET /cli/releases/{channel}/compatibility`	Evaluates a CLI version against a specific channel. Requires `currentVersion`; optional `platform`.

Query Parameters

Parameter	Applies to	Description
`platform`	manifests, history, compatibility	Filters packages to a specific platform identifier (for example, `macos-arm64`).
`take`	history	Limits the number of releases returned (positive values only, max 50).
`channel`	history	Filters history to a specific channel.
`currentVersion`	compatibility	Required CLI version to evaluate (semantic version string).

Response Models

Release Manifest

GET /cli/releases, GET /cli/releases/{channel}, and GET /cli/releases/history return release manifest objects with:

channel: Channel name that produced the release.
version: Release version string.
minSupportedVersion: Minimum supported CLI version.
publishedAt: Timestamp of release publication.
releaseNotesUrl: Optional link to release notes.
packages: Array of platform packages, each including:
- platform: Platform identifier.
- downloadUrl: Direct download URL.
- signatureUrl: Optional detached signature URL.
- sha256: Optional SHA-256 checksum.
- sizeBytes: Optional package size in bytes.

Compatibility Response

Compatibility endpoints return:

channel, currentVersion, latestVersion, minSupportedVersion
isSupported, upgradeRequired, updateAvailable
releaseNotesUrl
status, message
preferredPackagePlatform, preferredPackageDownloadUrl
preferredPackageSignatureUrl, preferredPackageSha256, preferredPackageSizeBytes, preferredPackageFileName

Error Handling

404 responses indicate an unknown channel.
400 responses indicate invalid parameters (for example, non-positive take values).
Compatibility responses surface actionable status and message fields to guide upgrades.

Example Requests

curl "https://api.coffeebreakai.dev/cli/releases/channels"
curl "https://api.coffeebreakai.dev/cli/releases/stable?platform=windows-x64"
curl "https://api.coffeebreakai.dev/cli/releases/stable/compatibility?currentVersion=2.4.1&platform=windows-x64"

Documentation