install

PairSpaces CLI Installer

The PairSpaces CLI lets you interact with PairSpaces from your terminal. This guide shows how to install or uninstall the PairSpaces CLI for macOS, Linux, and Windows.

Installation

macOS / Linux

Run this command in your terminal:

curl -fsSL https://raw.githubusercontent.com/pairspaces/install/main/install.sh | bash

You may need sudo to install into /usr/local/bin.

Optional flags:

• -u: Install to your user bin directory (~/.local/bin on Linux, ~/bin on macOS)
• -d <dir>: Install to a specific directory

curl -fsSL https://raw.githubusercontent.com/pairspaces/install/main/install.sh | bash -s -- -u

Windows (PowerShell)

Run these PowerShell commands:

$installerUrl = "https://raw.githubusercontent.com/pairspaces/install/main/install.bat"
$installerPath = "$env:USERPROFILE\Downloads\install_pair.bat"
Invoke-WebRequest -Uri $installerUrl -OutFile $installerPath
& $installerPath

Alternatively, run these Powershell commands:

cd "$env:USERPROFILE\Downloads"
curl https://raw.githubusercontent.com/pairspaces/install/main/install.bat -o install_pair.bat
.\install_pair.bat

Choose the Install option. The script installs the CLI to %USERPROFILE%\AppData\Local\pair\pair.exe and adds that directory to your user PATH.

Uninstalling PairSpaces CLI

macOS / Linux

Run the same install.sh script with the uninstall flag:

curl -fsSL https://raw.githubusercontent.com/pairspaces/install/main/install.sh | bash -s -- --uninstall

This will remove the installed binary from the target directory and delete config files in ~/.config/pair/.

Windows

Whether you downloaded install_pair.bat using Invoke-WebRequest or using cURL, run the install_pair.bat script and choose Uninstall.

This will remove the installed binary, remove the install directory from your PATH, and delete %LOCALAPPDATA%\pair and its contents.

Testing Installation

pair help

You should see the CLI’s usage output:

PairSpaces is for teams that work together. Learn more at https://pairspaces.com.

Usage:
  pair [command]

...

Tests

Linux, macOS

We use Bats to test the installation script. To run the tests, use:

bats tests/install.bats

Windows

We use Pester to test the installation script. We develop using Azure VM running Windows where there is an older version of Pester baked in to the image (v3.4).

To ensure tests use Pester v5, configure your $PROFILE:

# Clean out legacy module roots (prevents Pester 3.4 autoload)
$paths = $env:PSModulePath -split ';' | Where-Object {
    $_ -notlike '*WindowsPowerShell*' -and $_ -notlike '*v1.0*'
}
$env:PSModulePath = ($paths -join ';')

# Force Pester 5
Remove-Module Pester -ErrorAction SilentlyContinue
Import-Module "$HOME\Documents\PowerShell\Modules\Pester\5.7.1\Pester.psd1" -Force

To run the tests, use:

Invoke-Pester -CI

Requirements

• macOS/Linux: curl, bash
• Windows: PowerShell 5.0+

Support

Need help? Email support [at] pairspaces [dot] com.