Merge 936b922 into eb38a24

Author: Choraden

docs/dev/cli.md

@@ -17,7 +17,7 @@ hide_table_of_contents: true
 <div>
   <div className="box boxwidetop card">
     <div className="container">
-    <a href="/dev/cli/sauce-connect-5/run"><h3>Sauce Connect Proxy 5 CLI </h3></a>
+    <a href="/secure-connections/sauce-connect-5/cli/run"><h3>Sauce Connect Proxy 5 CLI </h3></a>
     <p>The CLI tool for deploying Sauce Connect Proxy 5 tunnels.</p>
     </div>
   </div>

docs/dev/cli/sauce-connect-5.md

@@ -1,85 +1,9 @@
 ---
 id: sauce-connect-5
-title: Sauce Connect Proxy 5 CLI Reference
-sidebar_label: sc
+title: Sauce Connect 5 CLI
 ---
 
-import useBaseUrl from '@docusaurus/useBaseUrl';
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
+# Sauce Connect 5 CLI
 
-Below is a list of commands available with your Sauce Connect Proxy application.
-
-## What You'll Need
-
-- Make sure you're using the latest [Sauce Connect Proxy version](/secure-connections/sauce-connect-5/installation/). Otherwise, some commands may not work.
-- See [Sauce Connect Quickstart](/secure-connections/sauce-connect-5/quickstart/) for setup instructions and use cases.
-
-<br/>
-
-## Commands
-
-- [sc run](/dev/cli/sauce-connect-5/run/)
-- [sc legacy](/dev/cli/sauce-connect-5/legacy/)
-- [sc completion](/dev/cli/sauce-connect-5/completion/)
-- `sc version`
-- `sc help`
-
-### `sc run`
-
-The [sc run](/dev/cli/sauce-connect-5/run/) command is a main Sauce Connect Proxy 5 command that allows provisioning a Sauce Connect Proxy server and establishing a secure connection between the Sauce Connect Proxy client and the server.
-
-### `sc legacy`
-
-The [sc legacy](/dev/cli/sauce-connect-5/legacy/) command runs Sauce Connect Proxy 5 in compatibility mode with Sauce Connect Proxy 4.
-
-### `sc completion`
-
-The [sc completion](/dev/cli/sauce-connect-5/completion/) command generates an autocompletion script for `bash`, `zsh`, `fish` and `powershell` shells. See each sub-command's help for details on how to use the generated script.
-
-### `sc version`
-
-The `sc version` command output detailed version info.
-
-```bash
-sc version
-  Version:	 5.0.0
-  Build time:	 2023-10-31T21:11:37Z
-  Git commit:	 9eb9a377aaa791765f74aace37e83d8ac1d000e2
-  Go Arch:	 arm64
-  Go OS:		 darwin
-  Go Version:	 go1.21.3
-```
-
-### `sc help`
-
-The `sc help` command allows getting usage for other commands
-
-```bash
-sc help
-Sauce Connect Proxy CLI opens a secure connection between Sauce Labs and a locally hosted applications. You can learn
-more at https://docs.saucelabs.com/secure-connections/sauce-connect-5/.
-
-Commands:
-  run           Run Sauce Connect Proxy
-
-Other Commands:
-  completion    Generate the autocompletion script for the specified shell
-  version       Print version information
-
-The following options can be passed to any subcommand:
-
-Other:
-    -c, --config-file <path> (env SAUCE_CONFIG_FILE)
-        Configuration file to load options from. The supported formats are: JSON, YAML, TOML, HCL, and Java
-        properties. The file format is determined by the file extension, if not specified the default format is YAML.
-        The following precedence order of configuration sources is used: command flags, environment variables, config
-        file, default values.
-
-Use "sc <command> --help" for more information about a given command.
-```
-
-## Additional Resources
-
-- [Sauce Connect Proxy Basic Setup](/secure-connections/sauce-connect-5/installation/).
-- [Sauce Connect Proxy Environment Variables](/secure-connections/sauce-connect-5/operation/configuration/#environment-variables/).
+- [sc run](/secure-connections/sauce-connect-5/cli/run) - Run Sauce Connect Proxy
+- [sc legacy](/secure-connections/sauce-connect-5/cli/legacy) - Run Sauce Connect Proxy in compatibility mode with Sauce Connect 4.9.X

docs/dev/cli/sauce-connect-5/completion.md

@@ -12,7 +12,7 @@ Below is a list of flags to use on your Sauce Connect Proxy v4.x.x command line
 
 :::note
 This is Sauce Connect Version 4 CLI documentation.
-The Sauce Connect Proxy version 5 major release introduced breaking CLI changes. Please refer to [Sauce Connect Proxy 5 CLI Reference](/dev/cli/sauce-connect-5/run/) for details.
+The Sauce Connect Proxy version 5 major release introduced breaking CLI changes. Please refer to [Sauce Connect Proxy 5 CLI Reference](/secure-connections/sauce-connect-5/cli/run/) for details.
 :::
 
 ## What You'll Need

docs/dev/cli/sauce-connect-proxy.md

@@ -13,8 +13,8 @@ Sauce Connect Proxy 5 is a complete rewrite of Sauce Connect Proxy 4.x.x that ai
 ## What's New In Sauce Connect Proxy 5?
 
 :::caution
-The Sauce Connect Proxy version 5 major release introduces CLI changes. Please refer to [Sauce Connect Proxy 5 CLI Reference](/dev/cli/sauce-connect-5/run/) for details.
-An [`sc legacy`](/dev/cli/sauce-connect-5/legacy/) command is introduced to help users transition from version 4.x.x to 5.0.x.
+The Sauce Connect Proxy version 5 major release introduces CLI changes. Please refer to [Sauce Connect Proxy 5 CLI Reference](/secure-connections/sauce-connect-5/cli/run/) for details.
+An [`sc legacy`](/secure-connections/sauce-connect-5/cli/legacy/) command is introduced to help users transition from version 4.x.x to 5.0.x.
 :::
 
 1. Improved onboarding and integration due to the secure connection (tunnel) protocol change.
@@ -34,13 +34,13 @@ An [`sc legacy`](/dev/cli/sauce-connect-5/legacy/) command is introduced to help
 
 Sauce Connect Proxy 5 major changes are listed below.
 
-- Tunnels must be named, the [`--tunnel-name`](/dev/cli/sauce-connect-5/run/#--tunnel-name) flag is no longer optional. It's done to improve security and usability - tests that use Sauce Connect must explicitly specify the [tunnel name](/dev/test-configuration-options/#tunnelname).
-- There is no default Sauce Labs region value, [`--region`](/dev/cli/sauce-connect-5/run/#--region) is required to ensure that the correct region is explicitly specified.
+- Tunnels must be named, the [`--tunnel-name`](/secure-connections/sauce-connect-5/cli/run/#--tunnel-name) flag is no longer optional. It's done to improve security and usability - tests that use Sauce Connect must explicitly specify the [tunnel name](/dev/test-configuration-options/#tunnelname).
+- There is no default Sauce Labs region value, [`--region`](/secure-connections/sauce-connect-5/cli/run/#--region) is required to ensure that the correct region is explicitly specified.
 - [SSL Certificate Bumping](/secure-connections/sauce-connect/security-authentication#ssl-certificate-bumping) is not enabled for all domains, by default.
   - [SSL Certificate Bumping](/secure-connections/sauce-connect/security-authentication#ssl-certificate-bumping) is fully supported and additional flags are added to fine-tune the configuration.
-- Proxy auto-detection is not supported, all proxies must be specified with explicit flags - [`--proxy`](/dev/cli/sauce-connect-5/run/#--proxy) or [`--pac`](/dev/cli/sauce-connect-5/run/#--pac) for SUT requests and [`--proxy-sauce`](/dev/cli/sauce-connect-5/run/#--proxy-sauce) for Sauce Labs REST API and tunnel connections.
-- Domain flags ([`--tunnel-domains`](/dev/cli/sauce-connect-5/run/#--tunnel-domains), [`--direct-domains`](/dev/cli/sauce-connect-5/run/#--direct-domains), etc) accept regular expressions only.
-- [Subcommands](/dev/cli/sauce-connect-5/) are introduced to support multiple CLI changes and future capabilities.
+- Proxy auto-detection is not supported, all proxies must be specified with explicit flags - [`--proxy`](/secure-connections/sauce-connect-5/cli/run/#--proxy) or [`--pac`](/secure-connections/sauce-connect-5/cli/run/#--pac) for SUT requests and [`--proxy-sauce`](/secure-connections/sauce-connect-5/cli/run/#--proxy-sauce) for Sauce Labs REST API and tunnel connections.
+- Domain flags ([`--tunnel-domains`](/secure-connections/sauce-connect-5/cli/run/#--tunnel-domains), [`--direct-domains`](/secure-connections/sauce-connect-5/cli/run/#--direct-domains), etc) accept regular expressions only.
+- [Subcommands](/secure-connections/sauce-connect-5/cli/run) are introduced to support multiple CLI changes and future capabilities.
 - The [Selenium Relay](/secure-connections/sauce-connect/proxy-tunnels/#using-the-selenium-relay) feature is not supported.
 - Log administration capabilities (such as log-rotate) are not supported. Log management is better left to specialized tools.
 
@@ -54,4 +54,4 @@ If you already use Sauce Connect Proxy 4, please refer to [Sauce Connect Proxy 5
 
 - [Sauce Connect Proxy 5 Quickstart Guide](/secure-connections/sauce-connect-5/quickstart/)
 - [Sauce Connect Proxy 5 Migration Guide](/secure-connections/sauce-connect-5/migrating/)
-- [Sauce Connect Proxy 5 CLI Reference](/dev/cli/sauce-connect-5/)
+- [Sauce Connect Proxy 5 CLI Reference](/secure-connections/sauce-connect-5/cli/run)

docs/secure-connections/sauce-connect-5.md

@@ -0,0 +1,6 @@
+---
+id: config
+title: Config
+---
+
+TBD

docs/dev/cli/sauce-connect-5/sc_legacy.md renamed to docs/secure-connections/sauce-connect-5/cli/sc_legacy.md

@@ -43,7 +43,7 @@ Here are some benefits/use cases for using containerized Sauce Connect Proxy:
        --network="host" \
        -it saucelabs/sauce-connect:5.0
    ```
-   If desired, you can specify any additional [`sc run` options](/dev/cli/sauce-connect-5/run/) as environment variables.
+   If desired, you can specify any additional [`sc run` options](/secure-connections/sauce-connect-5/cli/run/) as environment variables.
 
    Alternatively, you can also mount a config file to the container by adding the `-v` option to the `docker run` command.
 

docs/dev/cli/sauce-connect-5/sc_run.md renamed to docs/secure-connections/sauce-connect-5/cli/sc_run.md

@@ -37,7 +37,7 @@ config:
 #terminationGracePeriodSeconds: 600
 ```
 
-For more information about the `config` values, see the [sc run command reference](https://docs.saucelabs.com/dev/cli/sauce-connect-5/run).
+For more information about the `config` values, see the [sc run command reference](/secure-connections/sauce-connect-5/cli/run).
 
 #### Install the Helm chart
 

docs/secure-connections/sauce-connect-5/config.md

@@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem';
 
 ## Debian/Ubuntu
 
-Sauce Connect provides `.deb` package with Systemd service for [Sauce Connect run](/dev/cli/sauce-connect-5/sc_run.md) command.
+Sauce Connect provides `.deb` package with Systemd service for [Sauce Connect run](/secure-connections/sauce-connect-5/cli/run) command.
 Other commands are available as well, but you will need to start them manually.
 
 ### Install package
@@ -60,7 +60,7 @@ sudo systemctl status sauce-connect
 
 ## RedHat/CentOS/Fedora
 
-Sauce Connect provides `.rpm` package with Systemd service for [Sauce Connect run](/dev/cli/sauce-connect-5/sc_run.md) command.
+Sauce Connect provides `.rpm` package with Systemd service for [Sauce Connect run](/secure-connections/sauce-connect-5/cli/run) command.
 Other commands are available as well, but you will need to start them manually.
 
 
@@ -172,7 +172,7 @@ sudo ln -s /opt/sauce-connect/completions/sc.bash /etc/bash_completion.d/sc
 ### Edit config file
 
 This step is optional. You can use default configuration or configure Sauce Connect with flags or environment variables.
-See [CLI reference](/dev/cli/sauce-connect-5/) for more details.
+See [CLI reference](/secure-connections/sauce-connect-5/cli/run) for more details.
 
 
 ```bash

docs/secure-connections/sauce-connect-5/installation/docker.md

@@ -22,7 +22,7 @@ brew install sauce-connect
 ### Edit config file
 
 This step is optional. You can use default configuration or configure Sauce Connect with flags or environment variables.
-See [CLI reference](/dev/cli/sauce-connect-5/) for more details.
+See [CLI reference](/secure-connections/sauce-connect-5/cli/run) for more details.
 
 ```bash
 vim sauce-connect.yaml
@@ -87,7 +87,7 @@ echo 'source <(sc completion bash)' >>~/.bash_profile
 ### Edit config file
 
 This step is optional. You can use default configuration or configure Sauce Connect with flags or environment variables.
-See [CLI reference](/dev/cli/sauce-connect-5/) for more details.
+See [CLI reference](/secure-connections/sauce-connect-5/cli/run) for more details.
 
 ```bash
 vim /opt/sauce-connect/sauce-connect.yaml

docs/secure-connections/sauce-connect-5/installation/kubernetes.md

@@ -69,7 +69,7 @@ Add-Content -Path $PROFILE -Value ". C:\sauce-connect\completions\sc.ps1"
 ### Edit config file
 
 This step is optional. You can use default configuration or configure Sauce Connect with flags or environment variables.
-See [CLI reference](/dev/cli/sauce-connect-5/) for more details.
+See [CLI reference](/secure-connections/sauce-connect-5/cli/run) for more details.
 
 ```bash
 notepad C:\sauce-connect\sauce-connect.yaml

docs/secure-connections/sauce-connect-5/installation/linux.md

@@ -0,0 +1,6 @@
+---
+id: metrics
+title: Metrics
+---
+
+TBD

docs/secure-connections/sauce-connect-5/installation/macos.md

@@ -33,7 +33,7 @@ You can now install or upgrade Sauce Connect version 5 with a package manager sy
 
 ## Quick Start using `sc legacy`
 
-The [`sc legacy`](/dev/cli/sauce-connect-5/legacy/) command is used to translate SC4 configuration to SC5.
+The [`sc legacy`](/secure-connections/sauce-connect-5/cli/legacy/) command is used to translate SC4 configuration to SC5.
 
 For a quick sanity check, you can start Sauce Connect with the legacy command:
 

docs/secure-connections/sauce-connect-5/installation/windows.md

@@ -9,7 +9,7 @@ import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
 Sauce Connect Proxy, optionally, exposes an API server that allows obtain information about the local Sauce Connect Proxy instance.
-The API interface is configured with the [`--api-address`](/dev/cli/sauce-connect-5/run/#--api-address) flag.
+The API interface is configured with the [`--api-address`](/secure-connections/sauce-connect-5/cli/run/#--api-address) flag.
 
 ```bash
 --api-address :8080 # listens on all the interfaces' port 8080
@@ -28,7 +28,7 @@ The table below summarizes available endpoints.
 | `/info`    | Returns runtime information about the tunnel instance.                                                 |
 | `/metrics` | Exposes [Prometheus](https://prometheus.io/) metrics.                                                  |
 | `/configz` | Returns the configuration values.                                                                      |
-| `/pac`     | Returns the PAC content being configured with the [`--pac`](/dev/cli/sauce-connect-5/run/#--pac) flag. |
+| `/pac`     | Returns the PAC content being configured with the [`--pac`](/secure-connections/sauce-connect-5/cli/run/#--pac) flag. |
 | `/version` | Returns the Sauce Connect Proxy instance version and build info.                                       |
 
 ### Info
@@ -51,4 +51,4 @@ The `/readyz` response is used to determine when Sauce Connect Proxy is ready to
 ## More Information
 
 - [Sauce Connect Proxy Overview](/secure-connections/sauce-connect/)
-- [Sauce Connect Proxy 5 CLI Reference](/dev/cli/sauce-connect-5/run/)
+- [Sauce Connect Proxy 5 CLI Reference](/secure-connections/sauce-connect-5/cli/run/)