Skip to content

Commit be521e7

Browse files
ChoradenChoraden
authored
Merge f5ba902 into a7d3f00 
2 parents a7d3f00 + f5ba902 commit be521e7

23 files changed

+773
-867
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: 2 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -1,89 +1,7 @@
11
---
22
id: completion
33
title: sc completion
4-
sidebar_label: sc completion
54
---
65

7-
Generate 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.
8-
9-
## Usage
10-
11-
```bash
12-
$ sc completion [OPTIONS]
13-
```
14-
15-
## Options
16-
17-
### <span className="cli">bash</span>
18-
19-
<div className="cli-desc">
20-
21-
#### Linux
22-
23-
```
24-
sc completion bash > /etc/bash_completion.d/sc
25-
```
26-
27-
#### macOS
28-
29-
```
30-
sc completion bash > /usr/local/etc/bash_completion.d/sc
31-
```
32-
33-
</div>
34-
35-
### <span className="cli">zsh</span>
36-
37-
<div className="cli-desc">
38-
39-
1. If shell completion is not already enabled in your environment, enable it by executing the following once:
40-
41-
```
42-
echo "autoload -U compinit; compinit" >> ~/.zshrc
43-
```
44-
45-
2. To load completions for each session, execute once:
46-
47-
```
48-
sc completion zsh > "${fpath[1]}/_sc"
49-
```
50-
51-
3. Start a new shell to apply this setup.
52-
53-
</div>
54-
55-
### <span className="cli">fish</span>
56-
57-
<div className="cli-desc">
58-
59-
```
60-
sc completion fish | source
61-
```
62-
63-
To load completions for each session, execute once:
64-
65-
```
66-
sc completion fish > ~/.config/fish/completions/sc.fish
67-
```
68-
69-
</div>
70-
71-
### <span className="cli">Powershell</span>
72-
73-
<div className="cli-desc">
74-
75-
```
76-
sc completion powershell | Out-String | Invoke-Expression
77-
```
78-
79-
To load completions for every new session, run the following and then source this file from your Powershell profile:
80-
81-
```
82-
sc completion powershell > sc.ps1
83-
```
84-
85-
</div>
86-
87-
## Additional Resources
88-
89-
- [Sauce Connect Proxy Basic Setup](/secure-connections/sauce-connect-5/installation/).
6+
# This page has been moved
7+
See [Sauce Connect 5 CLI completion documentation](/secure-connections/sauce-connect-5/cli/sc/#command-line-autocompletion).

0 commit comments

Comments
 (0)