Skip to main content

Getting Started

The ComputeSphere CLI (csph) provides access to features of the ComputeSphere Console from your terminal. It also supports an interactive mode.

Installation​

Install csph using whichever method suits your platform.

Homebrew (macOS / Linux)​

brew install computesphere/cli/csph

Install script (macOS / Linux)​

curl -fsSL https://install.computesphere.com | sh

The script verifies the release checksum and installs csph to ~/.local/bin. Set CSPH_INSTALL_DIR to change the location, or CSPH_VERSION to pin a specific version.

npm (any platform with Node.js)​

Run it once, with no install:

npx @computesphere/csph deploy

Or install it globally:

npm install -g @computesphere/csph

The matching platform binary is installed automatically as an optional dependency, so this works with npx and npm install --ignore-scripts.

Chocolatey (Windows)​

choco install computesphere

This installs the csph command.

Install script (Windows, PowerShell)​

irm https://install.computesphere.com/install.ps1 | iex

Manual download​

  1. Open the latest release.
  2. Download the archive for your platform — for example windows_amd64.zip, darwin_arm64.tar.gz, or linux_amd64.tar.gz.
  3. Extract it and move the csph binary onto your PATH.

Authentication​

After installing the CLI, authenticate by running:

csph auth login

csph uses device-code login by default: it prints a code and a URL — open the URL, enter the code, and confirm. This works in plain terminals, SSH sessions, and CI, with no browser required on the machine running the CLI.