Installation | Authorization | Usage | Changelog
The Steadybit CLI enables you to use the Steadybit platform features easier in an automated way and implement e.g. GitOps practices easily. You can retrieve, create or adjust experiment designs as well as running them straight away.
- You need to have a Steadybit account. You can create a free account via our website.
- at least Node.js 16 as local runtime
Via npm
npm install -g steadybit
You need an API access token. You can grab one via our platform through the Settings -> API Access Tokens
page.
➜ steadybit config profile add
? Profile name: steadybit
? API access token: [hidden]
? Base URL of the Steadybit server: https://platform.steadybit.io
Get an existing experiment yaml from Steadybit and write it to file:
steadybit experiment get -k ADM-1 -f experiment.yml
Only apply the experiment:
steadybit experiment apply -f experiment.yml
Apply and run the experiment in one step:
steadybit experiment run -f experiment.yml
Run existing experiment:
steadybit experiment run -k ADM-1
Dump all experiments and executions from all teams:
steadybit experiment dump -d ./dump
Validate advice status
steadybit validate-status -e "Global" -q "k8s.cluster-name=dev-demo and k8s.namespace=steadybit-demo"
You can also use the cli via our container image:
docker run -e"STEADYBIT_TOKEN=****" steadybit/cli:latest experiment get -k ADM-1