diff --git a/docs/visual-testing/cli.md b/docs/visual-testing/cli.md index fb4d354c2c..53691be757 100644 --- a/docs/visual-testing/cli.md +++ b/docs/visual-testing/cli.md @@ -4,12 +4,17 @@ title: Sauce Visual CLI sidebar_label: Sauce Visual CLI --- -The Sauce Visual CLI (command line interface) allows you to easily interact with Sauce Visual, streamlining your visual testing workflows. With this tool, you can create new builds, mark builds as completed, and retrieve the current status of any build. This simplifies the process of integrating visual testing into your continuous integration and delivery pipelines, ensuring efficient and accurate visual validation of your web applications. +The Sauce Visual CLI (command line interface) allows you to easily interact with Sauce Visual, streamlining your visual testing workflows. With this tool, you can create new builds, mark builds as completed, and retrieve the current status of any build. This simplifies the process of integrating visual testing into your continuous integration and delivery pipelines, ensuring efficient and accurate visual validation of your applications. ## What You'll Need - A Sauce Labs account ([Log in](https://accounts.saucelabs.com/am/XUI/#login/) or sign up for a [free trial license](https://saucelabs.com/sign-up)) -- Your Sauce Labs [Username and Access Key](https://app.saucelabs.com/user-settings) +- Your Sauce Labs [Username and Access Key](https://app.saucelabs.com/user-settings) to be set in `SAUCE_USERNAME` and `SAUCE_ACCESS_KEY` environment variables + +```sh +export SAUCE_USERNAME=__YOUR_SAUCE_USERNAME__ +export SAUCE_ACCESS_KEY=__YOUR_SAUCE_ACCESS_KEY__ +``` ## System Requirements @@ -21,7 +26,11 @@ The Sauce Visual CLI (command line interface) allows you to easily interact with You can run Sauce Visual CLI using: - `npx @saucelabs/visual build [command] [options]` +`npx @saucelabs/visual build [command] [options]` + +Run the following command to see the list of available commands: + +`npx @saucelabs/visual build` ## Commands @@ -74,4 +83,14 @@ One of the following: #### Options -- `-r`, `--region`: The Sauce Labs region. Possible values: `us-west-1`, `eu-central-1`, `us-east-4`. Default: `us-west-1` \ No newline at end of file +- `-r`, `--region`: The Sauce Labs region. Possible values: `us-west-1`, `eu-central-1`, `us-east-4`. Default: `us-west-1` + +### help + +Displays help for a command + +Usage: `npx @saucelabs/visual build help [command]` + +Example: `npx @saucelabs/visual build help create` + +In addition to `help` command there's also `-h`, `--help` option available for every command to display the available options.