saucectl 0.175.0 → 0.176.0

package/README.md

@@ -5,18 +5,12 @@ Node.js wrapper for [saucectl](https://github.com/saucelabs/saucectl).
 
 ## Install
 
-To install `saucectl` using NPM just run:
+To install `saucectl` via `npm`, simply run the following command:
 
 ```sh
 $ npm i -g saucectl
 ```
 
-In case you need to download `saucectl` from a known source or in case you use `npx saucectl` you can use environment variable:
-
-```
-export SAUCECTL_INSTALL_BINARY=http://localhost:9000/saucectl_0.32.2_mac_64-bit.tar.gz
-```
-
 The command should be globally available:
 
 ```sh
@@ -25,11 +19,21 @@ saucectl version 0.4.0
 (build 7468a24c788b4ca4d67d50372c839edf03e5df6a)
 ```
 
-__Note:__ if you run the command for the first time it will initially download the binary for you. This only happens once.
+__Note:__ When you run the command for the first time, it will initially download the binary. This only happens once.
+
+__Note:__ `saucectl` installation is disabled on Sauce Labs Cloud. If you wish to force the installation, set the `SAUCECTL_FORCE_INSTALL` environment variable to `true`.
+
+### Install Binary from a Specified Source
+
+If you want the installer to download `saucectl` from a specific source, set the following environment variable:
+
+```
+export SAUCECTL_INSTALL_BINARY=http://localhost:9000/saucectl_0.32.2_mac_64-bit.tar.gz
+```
 
-### Install binary from Mirror
+### Install Binary from a Mirror Site
 
-Use the `SAUCECTL_INSTALL_BINARY_MIRROR` env to override the default download base site (https://github.com/saucelabs/saucectl/releases/download)
+Override the default download site by setting the `SAUCECTL_INSTALL_BINARY_MIRROR` environment variable to a custom URL. The default site is [Sauce Labs saucectl releases](https://github.com/saucelabs/saucectl/releases/download).
 
 ```bash
 SAUCECTL_INSTALL_BINARY_MIRROR=https://your-mirror-download-site.com/foo/bar npm i -g saucectl
@@ -37,4 +41,4 @@ SAUCECTL_INSTALL_BINARY_MIRROR=https://your-mirror-download-site.com/foo/bar npm
 
 ---
 
-For more information to `saucectl`, visit its main repository: [saucelabs/saucectl](https://github.com/saucelabs/saucectl).
+For more information about `saucectl`, visit its main repository: [saucelabs/saucectl](https://github.com/saucelabs/saucectl).

package/index.js

@@ -4,7 +4,7 @@ const path = require('path');
 const { BinWrapper } = require('@saucelabs/bin-wrapper');
 const { Writable } = require('stream');
 
-const version = '0.175.0';
+const version = '0.176.0';
 const defaultBinInstallBase =
   'https://github.com/saucelabs/saucectl/releases/download';
 const binWrapper = (binInstallURL = null, binInstallBase = null) => {

package/install.js

@@ -17,6 +17,12 @@ function sanitizeURL(inputURL) {
 // So we are 100% sure that the saucectl binary will be available for the next
 // execution.
 async function install() {
+  if (process.env.SAUCE_VM) {
+    if (!process.env.SAUCECTL_FORCE_INSTALL) {
+      console.info('Skipping the installation of saucectl on Sauce Cloud.');
+      return;
+    }
+  }
   console.info('Fetching saucectl binary');
   const bw = binWrapper(
     process.env.SAUCECTL_INSTALL_BINARY,
@@ -27,7 +33,7 @@ async function install() {
   }
   bw.run(['--version'])
     .then(() => {
-      console.info(`Installation succeed`);
+      console.info('Installation succeeded');
       process.exit(0);
     })
     .catch((e) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "saucectl",
-  "version": "0.175.0",
+  "version": "0.176.0",
   "description": "Node.js wrapper for saucectl",
   "main": "index.js",
   "bin": "index.js",