Documentation / CLI Command Reference A compact reference for Smoketest CLI command groups, parameters, and common flags.
Run smoketest <command> --help for the authoritative local help output. The tables below summarize the command surface.
Flag Purpose --profile <profile>Use a specific local credential profile --api-url <url>Override the Smoketest API URL --allow-insecure-api-urlAllow a non-HTTPS API URL outside localhost --jsonPrint machine-readable JSON where supported
Command Description smoketest init [--install]Guided signup/login or API-key import, with optional global install smoketest auth login [--browser] [--email <email>] [--api-key <key>]Sign in or import an API key smoketest auth signup [--email <email>] [--name <name>]Create an account with an email verification code smoketest auth whoamiShow the authenticated user and workspace smoketest auth logoutRemove stored credentials for the active profile
Command Description smoketest projects listList projects smoketest projects get <project>Show project detail smoketest projects create --name <name> [--url <url>] [--use]Create a project smoketest projects edit <project> [--name <name>] [--url <url>]Update a project smoketest projects delete <project> [--yes]Delete a project smoketest projects use <project>Save the default local project
Command Description smoketest tests list [--project <project>] [--tag <tag>]List tests smoketest tests get <test>Show test detail smoketest tests create --name <name> --url <url> --description <text-or-@file> [--project <project>] [--device desktop|mobile|both] [--env <persona>]Create a test smoketest tests edit <test> [--name <name>] [--url <url>] [--description <text-or-@file>] [--device desktop|mobile|both] [--env <persona>] [--editor]Edit a test smoketest tests delete <test> [--yes]Delete a test smoketest tests run <test> [--watch] [--url <url>]Trigger one test run smoketest tests run --tag <tag> [--project <project>] [--url <url>]Trigger runs for all tests with a tag smoketest tests schedule <test> [--schedule <preset>] [--enable|--disable]Inspect or update a schedule
Command Description smoketest shared-steps list [--project <project>]List reusable Shared Steps smoketest shared-steps get <shared-step> [--project <project>]Show Shared Step detail smoketest shared-steps create [--name <name>] [--description <text-or-@file>] [--editor] [--project <project>]Create a reusable Shared Step smoketest shared-steps edit <shared-step> [--name <name>] [--description <text-or-@file>] [--editor] [--project <project>]Edit a Shared Step smoketest shared-steps delete <shared-step> [--project <project>] [--yes]Delete a Shared Step
Command Description smoketest runs list [--project <project>] [--test <test>] [--status <status>]List recent runs smoketest runs get <run>Show run result and status smoketest runs watch <run>Watch live run status smoketest runs cancel <run> [--yes]Cancel an active run smoketest runs rerun <run> [--watch] [--url <url>]Rerun the same test
Supported run statuses are pending, running, passed, failed, error, and cancelled.
Command Description smoketest personas list [--project <project>]List Personas smoketest personas get <persona>Show Persona detail smoketest personas create --name <name> [--project <project>] [--var KEY=value] [--secret KEY=value]Create a Persona smoketest personas edit <persona> [--editor]Edit a variable set smoketest personas set <persona> KEY=value [--secret]Add or update a variable smoketest personas unset <persona> KEYRemove a variable smoketest personas delete <persona> [--yes]Delete a Persona
For --secret, pass KEY without =value to enter the value through a masked prompt.
Command Description smoketest billing statusShow subscription, credits, daily usage, and portal/checkout availability
Command Description smoketest config listList local config smoketest config get <key>Read a config value smoketest config set <key> <value>Set a config value smoketest config unset <key>Remove a config value smoketest profiles listList local credential profiles smoketest profiles use <profile>Switch active profile smoketest profiles delete <profile>Delete a local profile
smoketest completion zsh smoketest completion bash smoketest completion fish Use smoketest environments list|get|create|edit|delete for groups. Create/edit accepts repeated --persona <id-or-name>; edit also accepts --clear-personas. Use smoketest tests create ... --env <group> --persona <account> for explicit selection. Personas can be shared by several groups within one project. smoketest env is no longer supported.