CLI

The Smoketest CLI manages reusable Tests, Shared Steps, projects, environments, schedules, Runs, billing, and local profiles from your terminal. Jira/Linear Connections, Test Sources, Test Requests, and generated Tests stay in the app so the CLI cannot accidentally reroute ticket work.

It is useful for:

• Creating and running smoke tests without opening the dashboard
• Watching live run progress with a terminal UI
• Using Smoketest from CI and release scripts
• Managing projects, environments, and schedules through automation

Install

Run without installing globally:

npx @smoketest.sh/cli init

This runs the CLI through npm for the setup command. It signs you in, stores your local Smoketest profile, and then asks whether to install the CLI globally so future commands can use smoketest directly.

If you skip the global install, keep using the CLI through npx by prefixing each command:

npx @smoketest.sh/cli auth whoami
npx @smoketest.sh/cli projects list

Or install it once:

npm install --global @smoketest.sh/cli
smoketest init

The package installs two command names:

smoketest --help
st --help

st is a short alias for the same CLI.

Quick start

After installing globally, run:

smoketest init
smoketest projects create --name "Production" --url https://example.com --use
smoketest tests create \
  --name "Homepage smoke test" \
  --url https://example.com \
  --description "Open the homepage, check the main CTA, and verify pricing is reachable"
smoketest tests run "Homepage smoke test" --watch

If you prefer not to install globally, replace smoketest with npx @smoketest.sh/cli in those commands.

The --watch view shows run status, completed actions, the current agent action, final result, artifact links, and a dashboard link for the full recording.

Command groups

Use smoketest <command> --help for exact flags.

CLI and API resources

CLI Tests map directly to reusable Tests in the public /v1/tests API.

For example:

smoketest tests list

calls the same public API surface as /v1/tests.

Next steps