From debc1875b28f0550c6e4616e1585bef96937cae4 Mon Sep 17 00:00:00 2001 From: Kerem Beygo Date: Fri, 19 Jul 2024 15:50:59 +0200 Subject: [PATCH 1/5] Add help command for Sauce Visual CLI --- docs/visual-testing/cli.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/visual-testing/cli.md b/docs/visual-testing/cli.md index fb4d354c2c..c8c7fa470e 100644 --- a/docs/visual-testing/cli.md +++ b/docs/visual-testing/cli.md @@ -23,8 +23,20 @@ You can run Sauce Visual CLI using: `npx @saucelabs/visual build [command] [options]` +Run the following command to see the list of available commands: + + `npx @saucelabs/visual build` + ## Commands +### help + +Displays help for a command + +Usage: `npx @saucelabs/visual build help [command]` + +Example: `npx @saucelabs/visual build help create` + ### create Creates a Sauce Visual build From 113010f6804fccabe19ebda305048000224fad3b Mon Sep 17 00:00:00 2001 From: Kerem Beygo Date: Fri, 19 Jul 2024 15:51:37 +0200 Subject: [PATCH 2/5] Add help command for Sauce Visual CLI --- docs/visual-testing/cli.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/visual-testing/cli.md b/docs/visual-testing/cli.md index c8c7fa470e..d196eb8d66 100644 --- a/docs/visual-testing/cli.md +++ b/docs/visual-testing/cli.md @@ -29,14 +29,6 @@ Run the following command to see the list of available commands: ## Commands -### help - -Displays help for a command - -Usage: `npx @saucelabs/visual build help [command]` - -Example: `npx @saucelabs/visual build help create` - ### create Creates a Sauce Visual build @@ -86,4 +78,12 @@ 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` \ No newline at end of file From 85f967d00b5cc33f3aba90d61cfe837c84c788a7 Mon Sep 17 00:00:00 2001 From: Kerem Beygo Date: Fri, 19 Jul 2024 15:53:18 +0200 Subject: [PATCH 3/5] Add help command for Sauce Visual CLI --- docs/visual-testing/cli.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/visual-testing/cli.md b/docs/visual-testing/cli.md index d196eb8d66..388cbdd943 100644 --- a/docs/visual-testing/cli.md +++ b/docs/visual-testing/cli.md @@ -4,7 +4,7 @@ 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 @@ -86,4 +86,6 @@ Displays help for a command Usage: `npx @saucelabs/visual build help [command]` -Example: `npx @saucelabs/visual build help create` \ No newline at end of file +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. \ No newline at end of file From 71c3c267d8f0a6ee7554cf234893cc844c1a3100 Mon Sep 17 00:00:00 2001 From: Kerem Beygo Date: Fri, 19 Jul 2024 15:54:00 +0200 Subject: [PATCH 4/5] Add help command for Sauce Visual CLI --- docs/visual-testing/cli.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/visual-testing/cli.md b/docs/visual-testing/cli.md index 388cbdd943..825795f1cc 100644 --- a/docs/visual-testing/cli.md +++ b/docs/visual-testing/cli.md @@ -88,4 +88,4 @@ 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. \ No newline at end of file +In addition to `help` command there's also `-h`, `--help` option available for every command to display the available options. From bc5d9d29cf981bf8ea5940cb513e7badb5f71c2c Mon Sep 17 00:00:00 2001 From: Kerem Beygo Date: Fri, 19 Jul 2024 16:02:14 +0200 Subject: [PATCH 5/5] Sauce username and access key env vars --- docs/visual-testing/cli.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/visual-testing/cli.md b/docs/visual-testing/cli.md index 825795f1cc..53691be757 100644 --- a/docs/visual-testing/cli.md +++ b/docs/visual-testing/cli.md @@ -9,7 +9,12 @@ The Sauce Visual CLI (command line interface) allows you to easily interact with ## 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,11 +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` +`npx @saucelabs/visual build` ## Commands