Developer tool

A command line tool for Shopify checkout monitoring

By Gary Gillespie · Last updated

If you would rather not click through a dashboard, the rs CLI gives you the whole monitoring loop as single commands that you can script, alias, or drop into a pipeline.

Install and configure

The CLI is a small Python package. Install it, then point it at your API key:

pip install -e .            # installs the "rs" command
rs config                   # shows the resolved API base + whether a key is loaded

It reads the admin key and API base from environment variables (or a local env file), never from a hardcoded value, so the same binary works against production or a local stack.

Onboard a store by URL

The fastest path from nothing to live monitoring is a single command:

rs add https://clientstore.com                 # auto-discover an in-stock product, go live
rs add https://clientstore.com --product blue-widget   # pin a specific product handle
rs add https://clientstore.com --slack https://hooks.slack.com/services/XXX  # + Slack alerts

rs add discovers an in-stock product, generates the checkout test, and starts it on a schedule. It does this through the same out-of-the-box test generator the Shopify app uses, so there is nothing new to configure.

The everyday commands

rs list                       # monitored stores
rs status clientstore.com     # a store's tests, latest run and schedule
rs runs clientstore.com       # run history for a store
rs run <test-id>              # queue a manual run now
rs evidence <run-id>          # print the signed video URL(s) for a run

Every command accepts a global --json flag, so you can pipe output into jq or a script:

rs --json tests clientstore.com | jq '.tests[].id'

Run a checkout test in CI

Because rs run triggers a real checkout test and rs runs reports the result as JSON, you can gate a deploy on checkout actually working. A pipeline step can trigger a run after a theme or app change, poll for the result, and fail the build if the checkout test did not pass, with a link to the failure video in the logs. That turns "did our last release break checkout?" from a support ticket into a red build.

Frequently asked questions

Can I run a Shopify checkout test from the command line?
Yes. "rs run " queues a real checkout run (desktop and mobile), and "rs runs " reports the result. With the --json flag you can script the whole loop from CI.
What does "rs add" actually do?
It takes a store URL, auto-discovers an in-stock product, generates a checkout test through the standard out-of-the-box generator, and starts monitoring on a schedule. You can pin a specific product and attach a Slack webhook in the same command.
Does the CLI do anything the dashboard cannot?
No, by design. It is a thin wrapper over the same API the dashboard uses. Its value is that it is scriptable: aliases, pipelines, cron and CI instead of clicks.

See it on your own store — free

Run a free checkout health scan on any live Shopify store. No install, no card. Results in about 8 minutes, with step-by-step video proof.

Scan my store freeor install on Shopify →

Rated 5/5 by merchants on the Shopify App Store