Skip to content

docs: the CLI is a Go binary now and covers what the API does - #222

Merged
achoimet merged 2 commits into
mainfrom
docs/cli-v6
Oct 1, 2026
Merged

achoimet merged 2 commits into
mainfrom
docs/cli-v6

Conversation

@achoimet

@achoimet achoimet commented Sep 29, 2026 •

Copy link
Copy Markdown
Member

Steadybit CLI v6.0.0 was released on 2026-09-28. It's a Go binary that covers the platform API's use cases, so two pages were out of date.

CLI page (integrate-with-steadybit/cli.md)

  • Installation: brew install steadybit/tap/steadybit, the release archives, the steadybit/cli container image, uses: steadybit/cli@v6, and go install. npm install -g steadybit is gone, and a hint tells v5 users how to switch. Their profiles keep working.
  • Authentication: config profile add, or STEADYBIT_TOKEN / STEADYBIT_URL in pipelines.
  • Usage: running an experiment in a pipeline, and keeping a team in Git with export / diff / apply.

Integrations overview (integrate-with-steadybit/README.md)

  • The CLI paragraph no longer says it's an npm package.
  • CLI vs. API: the old table marked templates, schedules, the emergency stop, targets and configuration as API-only. All of them have CLI commands now, so a ✅/❌ grid would be ✅ everywhere. The section now says what the CLI covers and compares how each is used: purpose, setup, configuration as code, running experiments.
  • It lists what only the API offers. I checked this against the spec: of its 136 operations, the CLI doesn't call the license endpoints, target statistics, saved landscape views, badges, run search across experiments, the hub connection check, the preflight action list, or health.
  • Footnote 2 described the old table's last column and goes with it.

The API's new optimistic locking (version / 409 Conflict) is only on dev so far, so it's documented in a separate PR to merge with that platform release.

python3 .github/scripts/docs_lint.py --base origin/main: 0 errors, 0 warnings.

Steadybit CLI v6 is a single binary installed with Homebrew, a download, the
container image, the GitHub Action, or go install; it is no longer an npm
package. It covers the same use cases as the API, so the CLI vs. API table,
which showed templates, schedules, the emergency stop, targets, and
configuration as API-only, now compares how the two are used instead, and
names the few things only the API offers.
@achoimet
achoimet merged commit 8006d9a into main Oct 1, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant