CLI
npm install -g @flarely/cli # or npx @flarely/cli export FLARELY_TOKEN=fl_api_...
Set FLARELY_PROJECT when the token can see more than one project.
| Command | What |
|---|---|
flarely run <checkId...> or --all | Trigger, wait, print a summary. Exit 0 passed, 1 failed, 2 error. |
flarely push <dir> --name <name> | Upload a folder as a new check. --check <id> makes a version instead; --run runs it. |
flarely configure <checkId> | --cron, --base-url, --env, --name, --pause, --resume. |
flarely delete <checkId> --yes | Delete a check with its runs, artifacts, incidents and proposals. Permanent; pause instead if you might want it back. |
flarely checks, flarely incidents, flarely deploys | Lists. |
flarely context <runId> | The failure context as JSON. |
flarely alerts, flarely hooks | Alert channels and deploy hooks: list, add, remove, test. |
flarely billing, flarely upgrade solo|team, flarely buy runs-2500|runs-10000 | Plan, usage and prepaid run credits; a checkout link for a plan or a run pack. |
Run options
--base-url sets BASE_URL; --env KEY=VALUE adds more; --retries n re-runs a failing check and reports it as flaky if it then passes; --format text|json|markdown; --summary-file and --comment-file write the JSON and Markdown summaries. Artifact links in summaries are signed and work for a week without a token.
In any CI
flarely run --all --base-url "$PREVIEW_URL" --retries 1 --comment-file comment.md
On GitHub, the Action wraps this and posts the comment.