Install the CLI

The publicsurface CLI is the fastest way to send data, manage projects, and query your Public Surface workspace from a terminal. It runs on macOS, Linux, and Windows (via WSL).

Requirements

You need a Public Surface account and a project API key. If you do not have a project yet, create one from the dashboard before continuing.

Install

curl -fsSL https://cli.example.com/install.sh | sh

curl -fsSL https://cli.example.com/install.sh | sh

curl -fsSL https://cli.example.com/install.sh | sh

The installer places the binary at /usr/local/bin/publicsurface and adds a single line to your shell profile.

Verify the install

publicsurface --version

publicsurface --version

publicsurface --version

You should see the installed version number printed, for example publicsurface/1.8.2.

If the command is not found after installing, restart your terminal or re-source your shell profile.

Once the CLI is installed, continue with the Quickstart to send your first event.