Installation

This guide covers all methods to install the OpsSquad CLI on your system.

Quick Install

The fastest way to get started is using the automated installation script:

curl -fsSL https://install.opssquad.ai/install.sh | bash

The script automatically:

Detects your platform (Linux/macOS/Windows)
Downloads the latest version
Installs to the correct location
Adds opssquad to your PATH

Note: The installation script is safe to run multiple times. It will update an existing installation to the latest version.

Manual Installation

If you prefer to install manually, download the binary for your platform and install it yourself.

Linux (amd64)

# Download the binary
curl -LO https://github.com/opssquad/opssquad-cli-tool/releases/latest/download/opssquad-linux-amd64.tar.gz

# Extract
tar -xzf opssquad-linux-amd64.tar.gz

# Install to system path
sudo mv opssquad /usr/local/bin/

# Verify installation
opssquad --version

Linux (arm64)

# Download the binary
curl -LO https://github.com/opssquad/opssquad-cli-tool/releases/latest/download/opssquad-linux-arm64.tar.gz

# Extract
tar -xzf opssquad-linux-arm64.tar.gz

# Install to system path
sudo mv opssquad /usr/local/bin/

# Verify installation
opssquad --version

macOS (Apple Silicon)

# Download the binary
curl -LO https://github.com/opssquad/opssquad-cli-tool/releases/latest/download/opssquad-darwin-arm64.tar.gz

# Extract
tar -xzf opssquad-darwin-arm64.tar.gz

# Install to system path
sudo mv opssquad /usr/local/bin/

# Verify installation
opssquad --version

Note: On macOS, you may need to allow the binary in System Preferences > Security & Privacy if you see a "developer cannot be verified" warning.

macOS (Intel)

# Download the binary
curl -LO https://github.com/opssquad/opssquad-cli-tool/releases/latest/download/opssquad-darwin-amd64.tar.gz

# Extract
tar -xzf opssquad-darwin-amd64.tar.gz

# Install to system path
sudo mv opssquad /usr/local/bin/

# Verify installation
opssquad --version

Windows

Download the latest release from the GitHub Releases page
Extract opssquad-windows-amd64.exe from the archive
Rename to opssquad.exe and move to a directory in your PATH
Open a new Command Prompt or PowerShell and verify:

opssquad --version

Build from Source

If you need to build from source (for development or custom modifications):

Prerequisites

Go 1.21 or later

Build Steps

# Clone the repository
git clone https://github.com/opssquad/opssquad-cli-tool.git
cd opssquad-cli-tool

# Build the binary
go build -o opssquad

# Install to system path
sudo mv opssquad /usr/local/bin/

# Verify
opssquad --version

Requirements

Requirement	Details
Disk Space	Approximately 50MB (binary + logs)
Network	Outbound access to `socket.opssquad.ai:9000`
Permissions	Root access recommended for system-wide installation; user-level installation also supported

Installation Modes

The CLI supports two installation modes:

System Installation (Root)

When installed with root privileges (using sudo):

Component	Location
CLI Binary	`/usr/local/bin/opssquad`
Node Binary	`/usr/local/lib/opssquad/`
Configuration	`/etc/opssquad/node.yaml`
Logs	`/var/log/opssquad/node.log`
Service	`/etc/systemd/system/opssquad-connectivity-layer.service`

User Installation (Non-Root)

When installed without root privileges:

Component	Location
CLI Binary	`~/.local/bin/opssquad`
Node Binary	`~/.local/lib/opssquad/`
Configuration	`~/.config/opssquad/node.yaml`
Logs	`~/.local/log/opssquad/node.log`

Warning: User-mode installation does not create a systemd service. You'll need to manage the node process manually or set up your own service configuration.

Upgrading

To upgrade an existing installation to the latest version:

opssquad upgrade

This command:

Checks for the latest available version
Downloads the new binary
Replaces the existing installation
Preserves your configuration

Uninstalling

To completely remove OpsSquad:

# Stop and remove the node first
opssquad node uninstall

# Then remove the CLI binary
sudo rm /usr/local/bin/opssquad

Next Steps

Commands Reference - Learn all available CLI commands.
First Deployment - Deploy your first node.

Installation

On this page