Skip to content

CLI reference ​

Run these Flowstride (FS) commands from your npm project using npx flowstride, for example npx flowstride --version. Install Flowstride first with npm i flowstride.

CommandPurpose
flowstride --versionPrint the CLI package version
flowstride initScaffold project folders and bundled examples in a fresh project, then check Chromium setup
flowstride init --practiceAdd a separate practice project under .flowstride/practice
flowstride install [browsers...]Install matching chromium, firefox or webkit binaries; defaults to Chromium
flowstride install --with-depsAlso install operating-system dependencies, useful on Linux CI
flowstride run [path]Run a file or folder; defaults to configured testDir
flowstride reportOpen Saved Runs for native CI and Playwright Test results
flowstride openLaunch the Manual Workspace
flowstride loginConnect a Cloud account using a developer token and install its engine when needed
flowstride login --globalStore credentials for use across projects on this machine
flowstride statusCheck the current Cloud session/workspace
flowstride ci init githubExplicitly generate .github/workflows/flowstride.yml; optional --browsers and --shards
flowstride trace <file>Open a project-local trace ZIP
flowstride merge <summaries...>Merge complete, compatible shard results; optional --output <new-directory>

Run options ​

OptionBehavior
--ciHeadless execution, reports and process exit; no interactive dashboard
--headed / --headlessSet browser visibility; CI forces headless
--bail, -bStop later work after a failure
--workers <number>Requested parallel workers; Cloud capability subject to workspace limits
--device <profile>desktop, phone, or landscape; engine limits apply
--browser <engine>Select chromium (default), firefox, or webkit
--tag <name>Select scenarios with the tag. Repeat the option to match any supplied tag. Scenario tag examples
--shard <index/total>Select one deterministic CI file shard, for example 1/3
--shard-history <file>Use a complete merge's timing history for consistent shard balancing
--update-baselinesDeliberately create/update ARIA baselines locally; refused in CI
--config <file>Project-local configuration file
--env <name>Load .env.<name> before default .env
sh
npx flowstride run flows/account.flow --ci --env staging
npx flowstride run flows --tag smoke
npx flowstride run flows --workers 4
npx flowstride run flows --config flowstride.test.json

--workers is a run option, not a configuration-file field. Workspace and CPU limits may reduce the requested count. FS uses sequential execution.

--browser selects the engine for this run; install only downloads it. For whole-scenario retries, use configuration retries and failOnFlaky; there is no --retries flag. Native command reference lists the JSON command options.

Authentication ​

Use the masked interactive prompt for a local login:

sh
npx flowstride login

CI can provide FLOWSTRIDE_TOKEN as a secret, then call login when the Flowstride Pro engine needs to be installed. A --token option also exists, but putting a token in a shell command can expose it in history.

Saved runs ​

npx flowstride report opens Saved Runs from the current project. Use --no-open to print the URL. Use --legacy for older results written under reports/latest. Playwright reporting

For an active run, npx flowstride run opens the live dashboard in a regular local session. CI saves results and exits.

For an installed Flowstride Pro engine, use npx flowstride update to check for updates. See installation and updates.

Run tests locally or in your own CI, with optional authenticated Cloud reporting.

Cloud cleanup ​

The installed Flowstride Pro CLI additionally supports reset --values, reset --sessions and run --fresh for local runner state. These are not equivalent FS switches and do not delete application/backend data or Cloud login credentials. Read the cleanup scope before using them.

Flowstride is MIT licensed. Flowstride Cloud offers free and paid workspace plans.