Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

sc5: move CLI docs to secure connections section #2701

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/dev/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/sc"><h3>Sauce Connect Proxy 5 CLI </h3></a>
<p>The CLI tool for deploying Sauce Connect Proxy 5 tunnels.</p>
</div>
</div>
Expand Down
90 changes: 14 additions & 76 deletions docs/dev/cli/sauce-connect-5.md
Original file line number Diff line number Diff line change
@@ -1,85 +1,23 @@
---
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 Documentation Has Moved

Below is a list of commands available with your Sauce Connect Proxy application.
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.

## What You'll Need
## Quick Links to New Documentation

- 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.
- **Sauce Connect 5 CLI Overview**: [Visit Here](/secure-connections/sauce-connect-5/cli/sc)
- **Running Sauce Connect Proxy**: [sc run Documentation](/secure-connections/sauce-connect-5/cli/run)
- **Compatibility Mode (Legacy)**: [sc legacy Documentation](/secure-connections/sauce-connect-5/cli/legacy)
- **Command Line Autocompletion**: Learn more about sc completion:
- [linux](/secure-connections/sauce-connect-5/installation/linux/#add-bash-completion)
- [macOS](/secure-connections/sauce-connect-5/installation/macos/#add-completion)
- [windows](/secure-connections/sauce-connect-5/installation/windows/#add-completion)
- **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/).

<br/>
For any additional help or questions, please contact our support team.

## 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/).
Thank you for using Sauce Connect!
86 changes: 2 additions & 84 deletions docs/dev/cli/sauce-connect-5/completion.md
Original file line number Diff line number Diff line change
@@ -1,89 +1,7 @@
---
id: completion
title: sc completion
sidebar_label: sc completion
---

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.

## Usage

```bash
$ sc completion [OPTIONS]
```

## Options

### <span className="cli">bash</span>

<div className="cli-desc">

#### Linux

```
sc completion bash > /etc/bash_completion.d/sc
```

#### macOS

```
sc completion bash > /usr/local/etc/bash_completion.d/sc
```

</div>

### <span className="cli">zsh</span>

<div className="cli-desc">

1. If shell completion is not already enabled in your environment, enable it by executing the following once:

```
echo "autoload -U compinit; compinit" >> ~/.zshrc
```

2. To load completions for each session, execute once:

```
sc completion zsh > "${fpath[1]}/_sc"
```

3. Start a new shell to apply this setup.

</div>

### <span className="cli">fish</span>

<div className="cli-desc">

```
sc completion fish | source
```

To load completions for each session, execute once:

```
sc completion fish > ~/.config/fish/completions/sc.fish
```

</div>

### <span className="cli">Powershell</span>

<div className="cli-desc">

```
sc completion powershell | Out-String | Invoke-Expression
```

To load completions for every new session, run the following and then source this file from your Powershell profile:

```
sc completion powershell > sc.ps1
```

</div>

## Additional Resources

- [Sauce Connect Proxy Basic Setup](/secure-connections/sauce-connect-5/installation/).
# This page has been moved
See [Sauce Connect 5 CLI completion documentation](/secure-connections/sauce-connect-5/cli/sc/#command-line-autocompletion).
Loading
Loading