Skip to main content
Version: 1.1.0

VSAY Shell CLI

VSAY Shell CLI is a powerful command-line interface tool that allows you to manage your SSH connections and interact with VSAY Terminal directly from your terminal.

Overview

VSAY Shell CLI provides:

  • Command-line SSH management - Connect to machines without leaving your terminal
  • Script automation - Automate repetitive tasks with shell scripts
  • Lightweight - Minimal footprint, fast execution
  • Cross-platform - Works on Linux, macOS, and Windows

Installation

Using npm

npm install -g @vsay/shell-cli

Using Homebrew (macOS)

brew install vsay-shell-cli

Using apt (Debian/Ubuntu)

curl -fsSL https://packages.vsayterminal.com/gpg | sudo apt-key add -
echo "deb https://packages.vsayterminal.com/apt stable main" | sudo tee /etc/apt/sources.list.d/vsay.list
sudo apt update && sudo apt install vsay-shell-cli

Quick Start

Login

vsay login

List Machines

vsay machines list

Connect to a Machine

vsay connect <machine-name>

Execute Command on Remote Machine

vsay exec <machine-name> "ls -la"

Commands Reference

CommandDescription
vsay loginAuthenticate with VSAY Terminal
vsay logoutLog out from VSAY Terminal
vsay machines listList all available machines
vsay machines addAdd a new machine
vsay connect <name>Connect to a machine
vsay exec <name> <cmd>Execute command on machine
vsay configView/edit configuration
vsay versionShow CLI version

Configuration

Configuration file location: ~/.vsay/config.json

{
"apiUrl": "https://api.vsayterminal.com",
"defaultOrg": "my-organization",
"theme": "dark",
"timeout": 30000
}

Features

Session Management

# List active sessions
vsay sessions list

# Kill a session
vsay sessions kill <session-id>

File Transfer

# Upload file
vsay upload <machine-name> ./local-file.txt /remote/path/

# Download file
vsay download <machine-name> /remote/file.txt ./local-path/

Batch Operations

# Execute on multiple machines
vsay exec --tag production "sudo apt update"

Community vs Enterprise

FeatureCommunityEnterprise
Basic SSH connectionsYesYes
Machine managementYesYes
File transferYesYes
Multi-org supportNoYes
OIDC authenticationNoYes
Audit loggingBasicAdvanced
Priority supportNoYes