Skip to content

Installing or updating to the latest version

Jump to bottom
Atanas Chuchev edited this page Jul 31, 2022 · 5 revisions

Apache 2.0 License Community Supported Compatible with TPP 21.4+
To report a problem or share an idea, use Issues; and if you have a suggestion for fixing the issue, please include those details, too. Got questions or want to discuss something with our team? Join us on Slack!

Installing or updating the latest version of the vSSH CLI

This topic describes how to install or update the latest release of the vSSH CLI on supported operating systems. For information on the latest releases of vSSH CLI, see the vSSH CLI releases.

Quick installation

To quickly install vSSH CLI on Linux or macOS, run the following script. The script requires sudo and it will install vSSH CLI to /usr/local/bin/ directory.

Linux and macOS

curl -s https://raw.githubusercontent.com/Venafi/vssh-cli/main/.github/install.sh | sh

For Windows, you have to download one of the following archives and extract it yourself.

Step-by-step manual installation

Installation on Linux

Installation requirements

  • You must be able to extract or "unzip" the downloaded package. If your operating system doesn't have the built-in unzip command, use an equivalent.
  • vSSH CLI is supported on 32- and 64-bit versions of recent distributions of CentOS, Fedora, and Ubuntu.

Install the vSSH CLI

Follow these steps from the command line to install the vSSH CLI on Linux.

$ curl -L "https://github.com/Venafi/vssh-cli/releases/latest/download/vssh_linux_amd64.zip" -o "vssh.zip"
unzip vssh.zip
./vssh version
  1. Download the vSSH CLI archive in one of the following ways:
  • Use the curl command – The -o option specifies the file name that the downloaded package is written to. The options on the following example command write the downloaded file to the current directory with the local name vssh.zip.
$ curl -L "https://github.com/Venafi/vssh-cli/releases/latest/download/vssh_linux_amd64.zip" -o "vssh.zip"
  • Downloading from the URL – To download the vSSH CLI archive with your browser, go to vSSH CLI releases.
  1. Unzip the archive. If your Linux distribution doesn't have a built-in unzip command, use an equivalent to unzip it. The following command unzips the package and creates a file named vssh under the current directory.
$ unzip vssh.zip
  1. Confirm the installation with the following command.
$ ./vssh version
  Venafi SSH CLI Utility v1.0.2022 
  Build Time: 18 May 22 11:13 UTC
Installation on macOS

Installation requirements

  • vSSH CLI is supported on Mac with Intel chip (most common) and Apple chip (Nov 2020 and later).

Install the vSSH CLI

Follow these steps from the command line to install the vSSH CLI on macOS.

$ curl -L "https://github.com/Venafi/vssh-cli/releases/latest/download/vssh_darwin_amd64.zip" -o "vssh.zip"
unzip vssh.zip
./vssh version
  1. Download the vSSH CLI archive in one of the following ways:
  • Use the curl command – The -o option specifies the file name that the downloaded package is written to. The options on the following example command write the downloaded file to the current directory with the local name vssh.zip.
$ curl -L "https://github.com/Venafi/vssh-cli/releases/latest/download/vssh_darwin_amd64.zip" -o "vssh.zip"
  • Downloading from the URL – To download the vSSH CLI archive with your browser, go to vSSH CLI releases.
  1. Unzip the archive. The following example command unzips the package and creates a file named vssh under the current directory.
$ unzip vssh.zip
  1. Confirm the installation with the following command.
$ ./vssh version
  Venafi SSH CLI Utility v1.0.2022 
  Build Time: 18 May 22 11:13 UTC
Installation on Windows

Installation requirements

  • vSSH CLI is supported on Microsoft-supported versions of Windows.

Install the vSSH CLI

Follow these steps to install the vSSH CLI on Windows.

  1. Go to vSSH CLI releases to download the vSSH CLI utility for your version of Windows.
  2. Unzip the archive. The following PowerShell command unzips the package and creates a file named vssh under the current directory.
PS C:\> Expand-Archive vssh.zip -DestinationPath .
  1. Confirm the installation with the following command.
PS C:\> .\vssh.exe version
  Venafi SSH CLI Utility v1.0.2022 
  Build Time: 18 May 22 11:13 UTC

Update the vSSH CLI

If you are updating to the latest version, use the steps below on any supported operating system.

$ vssh update
  Looking for updates from Venafi/vssh-cli...  
  ? New version 1.0.2022 is available. Do you want to update (from 1.0.2021)? Yes
  Successfully updated to version 1.0.2022

If the vssh command cannot be found, you may need to restart your terminal or follow the instructions in Adding vSSH CLI to your OS path.

Next steps

After completing the steps in Prerequisites to use vSSH CLI with Venafi SSH Protect and installing the vSSH CLI, you should perform a quick setup to configure the vSSH CLI.

Clone this wiki locally