@simplr-ai/release-cli
v1.0.0
Published
Simplr release CLI — push commits and report CI test results to Simplr Release Notes from a git hook or CI step.
Downloads
878
Maintainers
Readme
@simplr-ai/release-cli
Push commits and CI test results to Simplr Release Notes from a git hook or CI step.
Feeds the same /v1/release-ingest API the GitHub App and VS Code extension use, so it
works for any provider.
Install
bun add -d @simplr-ai/release-cli # or npm i -DAuth
Create a project ingest token in the Simplr dashboard (Release Notes → project → Connect).
export SIMPLR_RELEASE_TOKEN=rnit_xxx
export SIMPLR_API_URL=https://api.simplr-ai.com # optional, this is the defaultCapture a commit
# Captures HEAD (sha, branch, message, author) automatically:
simplr-release release push
# Or be explicit / override the environment mapping:
simplr-release release push --ref main --env uat --title "Checkout v2"Wire it into .git/hooks/post-commit or a CI step to capture every push.
Report a test result (gates flag rollout + release publishing)
simplr-release test report --status passed --tag ci-main
simplr-release test report --status failed --tag ci-mainA feature flag with rollout_mode=auto and rollout_tag=ci-main will advance only
while the latest reported run for that tag is green, and halt on red — the same gate
GitHub Actions results feed.
Programmatic use
import { pushChange, reportTest } from "@simplr-ai/release-cli";
const opts = { apiUrl: "https://api.simplr-ai.com", token: process.env.SIMPLR_RELEASE_TOKEN! };
await pushChange(opts, { kind: "commit", title: "Fix login", ref: "main" });
await reportTest(opts, { status: "passed", tag: "ci-main" });