Skip to content

Commit 6c52bf8

Browse files
committed
sc5: move cli docs to secure connections section
This patch is a foundation to auto generated SC5 CLI docs. This moves all sc5 docs to one place. It has several advantages: - centralized information/unified structure: Users often look for all relevant documentation in one place. Having CLI docs next to other related docs reduces the need to navigate through different sections of the site, providing a smoother and more intuitive user experience. - consistent context/cross-referencing ease: Keeping related documents together helps maintain context for the user, as they can browse quickly through the sidebar. - discoverability: Users might not always know what they are looking for. By having CLI docs in the same location as other SC content, you increase the chances of users discovering useful commands and features they weren't initially aware of. - SEO benefits: From a web presence perspective, having a consolidated section with comprehensive coverage of a topic can improve search engine visibility. The SC5 CLI section will remain and point to new cli directory.
1 parent a7d3f00 commit 6c52bf8

21 files changed

+109
-239
lines changed

docs/dev/cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ hide_table_of_contents: true
1717
<div>
1818
<div className="box boxwidetop card">
1919
<div className="container">
20-
<a href="/dev/cli/sauce-connect-5/run"><h3>Sauce Connect Proxy 5 CLI </h3></a>
20+
<a href="/secure-connections/sauce-connect-5/cli/sc"><h3>Sauce Connect Proxy 5 CLI </h3></a>
2121
<p>The CLI tool for deploying Sauce Connect Proxy 5 tunnels.</p>
2222
</div>
2323
</div>

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

Lines changed: 14 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -1,85 +1,23 @@
11
---
22
id: sauce-connect-5
3-
title: Sauce Connect Proxy 5 CLI Reference
4-
sidebar_label: sc
3+
title: Sauce Connect 5 CLI
54
---
65

7-
import useBaseUrl from '@docusaurus/useBaseUrl';
8-
import Tabs from '@theme/Tabs';
9-
import TabItem from '@theme/TabItem';
6+
# Sauce Connect 5 CLI Documentation Has Moved
107

11-
Below is a list of commands available with your Sauce Connect Proxy application.
8+
The documentation you're looking for has been moved to a new location. Please use the links below to access the Sauce Connect 5 CLI documentation directly.
129

13-
## What You'll Need
10+
## Quick Links to New Documentation
1411

15-
- Make sure you're using the latest [Sauce Connect Proxy version](/secure-connections/sauce-connect-5/installation/). Otherwise, some commands may not work.
16-
- See [Sauce Connect Quickstart](/secure-connections/sauce-connect-5/quickstart/) for setup instructions and use cases.
12+
- **Sauce Connect 5 CLI Overview**: [Visit Here](/secure-connections/sauce-connect-5/cli/sc)
13+
- **Running Sauce Connect Proxy**: [sc run Documentation](/secure-connections/sauce-connect-5/cli/run)
14+
- **Compatibility Mode (Legacy)**: [sc legacy Documentation](/secure-connections/sauce-connect-5/cli/legacy)
15+
- **Command Line Autocompletion**: Learn more about sc completion:
16+
- [linux](/secure-connections/sauce-connect-5/installation/linux/#add-bash-completion)
17+
- [macOS](/secure-connections/sauce-connect-5/installation/macos/#add-completion)
18+
- [windows](/secure-connections/sauce-connect-5/installation/windows/#add-completion)
19+
- **Additional Resources**: For setup and configuration, see the [installation guide](/secure-connections/sauce-connect-5/installation) and [configuration guide](/secure-connections/sauce-connect-5/operation/configuration/).
1720

18-
<br/>
21+
For any additional help or questions, please contact our support team.
1922

20-
## Commands
21-
22-
- [sc run](/dev/cli/sauce-connect-5/run/)
23-
- [sc legacy](/dev/cli/sauce-connect-5/legacy/)
24-
- [sc completion](/dev/cli/sauce-connect-5/completion/)
25-
- `sc version`
26-
- `sc help`
27-
28-
### `sc run`
29-
30-
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.
31-
32-
### `sc legacy`
33-
34-
The [sc legacy](/dev/cli/sauce-connect-5/legacy/) command runs Sauce Connect Proxy 5 in compatibility mode with Sauce Connect Proxy 4.
35-
36-
### `sc completion`
37-
38-
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.
39-
40-
### `sc version`
41-
42-
The `sc version` command output detailed version info.
43-
44-
```bash
45-
sc version
46-
Version: 5.0.0
47-
Build time: 2023-10-31T21:11:37Z
48-
Git commit: 9eb9a377aaa791765f74aace37e83d8ac1d000e2
49-
Go Arch: arm64
50-
Go OS: darwin
51-
Go Version: go1.21.3
52-
```
53-
54-
### `sc help`
55-
56-
The `sc help` command allows getting usage for other commands
57-
58-
```bash
59-
sc help
60-
Sauce Connect Proxy CLI opens a secure connection between Sauce Labs and a locally hosted applications. You can learn
61-
more at https://docs.saucelabs.com/secure-connections/sauce-connect-5/.
62-
63-
Commands:
64-
run Run Sauce Connect Proxy
65-
66-
Other Commands:
67-
completion Generate the autocompletion script for the specified shell
68-
version Print version information
69-
70-
The following options can be passed to any subcommand:
71-
72-
Other:
73-
-c, --config-file <path> (env SAUCE_CONFIG_FILE)
74-
Configuration file to load options from. The supported formats are: JSON, YAML, TOML, HCL, and Java
75-
properties. The file format is determined by the file extension, if not specified the default format is YAML.
76-
The following precedence order of configuration sources is used: command flags, environment variables, config
77-
file, default values.
78-
79-
Use "sc <command> --help" for more information about a given command.
80-
```
81-
82-
## Additional Resources
83-
84-
- [Sauce Connect Proxy Basic Setup](/secure-connections/sauce-connect-5/installation/).
85-
- [Sauce Connect Proxy Environment Variables](/secure-connections/sauce-connect-5/operation/configuration/#environment-variables/).
23+
Thank you for using Sauce Connect!

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

Lines changed: 0 additions & 89 deletions
This file was deleted.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Below is a list of flags to use on your Sauce Connect Proxy v4.x.x command line
1212

1313
:::note
1414
This is Sauce Connect Version 4 CLI documentation.
15-
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.
15+
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/sc/) for details.
1616
:::
1717

1818
## What You'll Need

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ Sauce Connect Proxy 5 is a complete rewrite of Sauce Connect Proxy 4.x.x that ai
1313
## What's New In Sauce Connect Proxy 5?
1414

1515
:::caution
16-
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.
17-
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.
16+
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/sc/) for details.
17+
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.
1818
:::
1919

2020
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
3434

3535
Sauce Connect Proxy 5 major changes are listed below.
3636

37-
- 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).
38-
- 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.
37+
- 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).
38+
- 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.
3939
- [SSL Certificate Bumping](/secure-connections/sauce-connect/security-authentication#ssl-certificate-bumping) is not enabled for all domains, by default.
4040
- [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.
41-
- 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.
42-
- 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.
43-
- [Subcommands](/dev/cli/sauce-connect-5/) are introduced to support multiple CLI changes and future capabilities.
41+
- 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.
42+
- 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.
43+
- [Subcommands](/secure-connections/sauce-connect-5/cli/sc) are introduced to support multiple CLI changes and future capabilities.
4444
- The [Selenium Relay](/secure-connections/sauce-connect/proxy-tunnels/#using-the-selenium-relay) feature is not supported.
4545
- Log administration capabilities (such as log-rotate) are not supported. Log management is better left to specialized tools.
4646

@@ -54,4 +54,4 @@ If you already use Sauce Connect Proxy 4, please refer to [Sauce Connect Proxy 5
5454

5555
- [Sauce Connect Proxy 5 Quickstart Guide](/secure-connections/sauce-connect-5/quickstart/)
5656
- [Sauce Connect Proxy 5 Migration Guide](/secure-connections/sauce-connect-5/migrating/)
57-
- [Sauce Connect Proxy 5 CLI Reference](/dev/cli/sauce-connect-5/)
57+
- [Sauce Connect Proxy 5 CLI Reference](/secure-connections/sauce-connect-5/cli/sc)
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
id: sc
3+
title: sc
4+
---
5+
6+
# Sauce Connect 5 CLI Documentation
7+
8+
- **Running Sauce Connect Proxy**: [sc run Documentation](/secure-connections/sauce-connect-5/cli/run)
9+
- **Compatibility Mode (Legacy)**: [sc legacy Documentation](/secure-connections/sauce-connect-5/cli/legacy)
10+
- **Command Line Autocompletion**: Learn more about sc completion:
11+
- [linux](/secure-connections/sauce-connect-5/installation/linux/#add-bash-completion)
12+
- [macOS](/secure-connections/sauce-connect-5/installation/macos/#add-completion)
13+
- [windows](/secure-connections/sauce-connect-5/installation/windows/#add-completion)
14+
- **Additional Resources**: For setup and configuration, see the [installation guide](/secure-connections/sauce-connect-5/installation) and [configuration guide](/secure-connections/sauce-connect-5/operation/configuration/).
15+
16+
For any additional help or questions, please contact our support team.
17+
18+
Thank you for using Sauce Connect!

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Here are some benefits/use cases for using containerized Sauce Connect Proxy:
4343
--network="host" \
4444
-it saucelabs/sauce-connect:5.0
4545
```
46-
If desired, you can specify any additional [`sc run` options](/dev/cli/sauce-connect-5/run/) as environment variables.
46+
If desired, you can specify any additional [`sc run` options](/secure-connections/sauce-connect-5/cli/run/) as environment variables.
4747

4848
Alternatively, you can also mount a config file to the container by adding the `-v` option to the `docker run` command.
4949

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ config:
3737
#terminationGracePeriodSeconds: 600
3838
```
3939

40-
For more information about the `config` values, see the [sc run command reference](https://docs.saucelabs.com/dev/cli/sauce-connect-5/run).
40+
For more information about the `config` values, see the [sc run command reference](/secure-connections/sauce-connect-5/cli/run).
4141

4242
#### Install the Helm chart
4343

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem';
1010

1111
## Debian/Ubuntu
1212

13-
Sauce Connect provides `.deb` package with Systemd service for [Sauce Connect run](/dev/cli/sauce-connect-5/sc_run.md) command.
13+
Sauce Connect provides `.deb` package with Systemd service for [Sauce Connect run](/secure-connections/sauce-connect-5/cli/run) command.
1414
Other commands are available as well, but you will need to start them manually.
1515

1616
### Install package
@@ -60,7 +60,7 @@ sudo systemctl status sauce-connect
6060

6161
## RedHat/CentOS/Fedora
6262

63-
Sauce Connect provides `.rpm` package with Systemd service for [Sauce Connect run](/dev/cli/sauce-connect-5/sc_run.md) command.
63+
Sauce Connect provides `.rpm` package with Systemd service for [Sauce Connect run](/secure-connections/sauce-connect-5/cli/run) command.
6464
Other commands are available as well, but you will need to start them manually.
6565

6666

@@ -172,7 +172,7 @@ sudo ln -s /opt/sauce-connect/completions/sc.bash /etc/bash_completion.d/sc
172172
### Edit config file
173173

174174
This step is optional. You can use default configuration or configure Sauce Connect with flags or environment variables.
175-
See [CLI reference](/dev/cli/sauce-connect-5/) for more details.
175+
See [CLI reference](/secure-connections/sauce-connect-5/cli/run) for more details.
176176

177177

178178
```bash

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ brew install sauce-connect
2222
### Edit config file
2323

2424
This step is optional. You can use default configuration or configure Sauce Connect with flags or environment variables.
25-
See [CLI reference](/dev/cli/sauce-connect-5/) for more details.
25+
See [CLI reference](/secure-connections/sauce-connect-5/cli/run) for more details.
2626

2727
```bash
2828
vim sauce-connect.yaml
@@ -87,7 +87,7 @@ echo 'source <(sc completion bash)' >>~/.bash_profile
8787
### Edit config file
8888

8989
This step is optional. You can use default configuration or configure Sauce Connect with flags or environment variables.
90-
See [CLI reference](/dev/cli/sauce-connect-5/) for more details.
90+
See [CLI reference](/secure-connections/sauce-connect-5/cli/run) for more details.
9191

9292
```bash
9393
vim /opt/sauce-connect/sauce-connect.yaml

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Add-Content -Path $PROFILE -Value ". C:\sauce-connect\completions\sc.ps1"
6969
### Edit config file
7070

7171
This step is optional. You can use default configuration or configure Sauce Connect with flags or environment variables.
72-
See [CLI reference](/dev/cli/sauce-connect-5/) for more details.
72+
See [CLI reference](/secure-connections/sauce-connect-5/cli/run) for more details.
7373

7474
```bash
7575
notepad C:\sauce-connect\sauce-connect.yaml

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ You can now install or upgrade Sauce Connect version 5 with a package manager sy
3333

3434
## Quick Start using `sc legacy`
3535

36-
The [`sc legacy`](/dev/cli/sauce-connect-5/legacy/) command is used to translate SC4 configuration to SC5.
36+
The [`sc legacy`](/secure-connections/sauce-connect-5/cli/legacy/) command is used to translate SC4 configuration to SC5.
3737

3838
For a quick sanity check, you can start Sauce Connect with the legacy command:
3939

docs/secure-connections/sauce-connect-5/operation/api-server.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import Tabs from '@theme/Tabs';
99
import TabItem from '@theme/TabItem';
1010

1111
Sauce Connect Proxy, optionally, exposes an API server that allows obtain information about the local Sauce Connect Proxy instance.
12-
The API interface is configured with the [`--api-address`](/dev/cli/sauce-connect-5/run/#--api-address) flag.
12+
The API interface is configured with the [`--api-address`](/secure-connections/sauce-connect-5/cli/run/#--api-address) flag.
1313

1414
```bash
1515
--api-address :8080 # listens on all the interfaces' port 8080
@@ -28,7 +28,7 @@ The table below summarizes available endpoints.
2828
| `/info` | Returns runtime information about the tunnel instance. |
2929
| `/metrics` | Exposes [Prometheus](https://prometheus.io/) metrics. |
3030
| `/configz` | Returns the configuration values. |
31-
| `/pac` | Returns the PAC content being configured with the [`--pac`](/dev/cli/sauce-connect-5/run/#--pac) flag. |
31+
| `/pac` | Returns the PAC content being configured with the [`--pac`](/secure-connections/sauce-connect-5/cli/run/#--pac) flag. |
3232
| `/version` | Returns the Sauce Connect Proxy instance version and build info. |
3333

3434
### Info
@@ -51,4 +51,4 @@ The `/readyz` response is used to determine when Sauce Connect Proxy is ready to
5151
## More Information
5252

5353
- [Sauce Connect Proxy Overview](/secure-connections/sauce-connect/)
54-
- [Sauce Connect Proxy 5 CLI Reference](/dev/cli/sauce-connect-5/run/)
54+
- [Sauce Connect Proxy 5 CLI Reference](/secure-connections/sauce-connect-5/cli/sc/)

0 commit comments

Comments
 (0)