Skip to main content
Get up and running with Vers in just a few steps.

​
Prerequisites

  • Operating System: Linux or macOS
  • SSH Client: Required for connecting to VMs (usually pre-installed)
  • Terminal Access: Command-line interface

​
Install the CLI

Install the latest version of Vers CLI with a single command: 
curl -sSL https://vers.sh/api/install | bash
This script automatically detects your platform and downloads the appropriate binary to /usr/local/bin/vers. You may need administrative privileges for the installation.

​
Build from Source

If you prefer to build from source: 
git clone https://github.com/hdresearch/vers-cli.git
cd vers-cli
make build-and-install
This installs the binary to /usr/local/bin/vers.

​
Manual Download

Download the binary directly from vers.sh/beta and place it in your PATH.

​
Verify Installation

Check that Vers is properly installed: 
vers --version
You should see version information like v0.5.1.

​
Authentication

​
Get Your API Key

  1. Go to vers.sh and log in
  2. Subscribe to a plan for your organization (if you haven’t already)
  3. Navigate to API Keys in your organization settings
    • Use the org switcher in the top left to select your organization
  4. Create a new API key and copy it

​
Log In

vers login
Paste your API key when prompted. The key is stored locally at ~/.versrc.
You only need to log in once per machine. To see your current API key: cat ~/.versrc

​
Legacy Installation Cleanup

If you previously had a development version of Vers installed and want to switch to the production version:

​
Check Your Current Version

vers --version
If it shows dev instead of a version number like v0.5.1, follow these steps:

​
Remove the Dev Version

# Check where vers is installed
which vers

# If it shows /Users/<username>/go/bin/vers, remove it
rm -rf /Users/<username>/go/bin/vers

​
Verify the Switch

# Should now show a version number
vers --version

# Should now point to /usr/local/bin/vers
which vers

​
Re-authenticate

vers login
# Enter your API key from vers.sh

​
Next Steps

With Vers installed and authenticated, you’re ready to:
  1. Learn the core concepts
  2. Follow the quickstart guide
  3. Explore VM access and SSH

​
Troubleshooting

​
Command not found

Make sure /usr/local/bin is in your $PATH: 
echo $PATH
If it’s not included, add it to your shell configuration (~/.bashrc, ~/.zshrc, etc.): 
export PATH="/usr/local/bin:$PATH"

​
Authentication issues

  • Verify your API key is correct
  • Check that you have an active subscription at vers.sh
  • Try logging out and back in: vers logout && vers login

​
Installation script fails

Try one of these alternatives: 
# Run with sudo
curl -sSL https://vers.sh/api/install | sudo bash

# Or build from source
git clone https://github.com/hdresearch/vers-cli.git
cd vers-cli && make build-and-install