Quickstart

Quickstart guide to install the SuprSend CLI, authenticate with a service token, configure a workspace, and run your first commands in minutes.

If you install a binary (Homebrew, GitHub Releases, or source build), we recommend verifying the CLI signature to confirm the binary was built by SuprSend and has not been modified in transit. See Verify CLI Signature. Signature verification isn’t needed when you run via npx - npm registry integrity checks handle that for you.

Step 1: Run the CLI

The fastest way to use the SuprSend CLI is with npx - no install step, always the latest version. Requires Node.js 18+.

npx (Recommended)

Zero-install. Works on macOS, Linux, and Windows.

npx suprsend --help

Every invocation uses the latest published CLI. Run any command the same way:

npx suprsend workflow list

If you run CLI commands frequently, add an alias like alias suprsend="npx -y suprsend" to your shell profile so you can just type suprsend ....

Homebrew

For macOS or Linux users who prefer a package-manager install.

brew tap suprsend/tap
brew install --cask suprsend

Binary Releases

Best for Windows users, servers or CI/CD environments without Node.js.

Download the binary for your platform from GitHub Releases and install it:

macOS / Linux

chmod +x suprsend
sudo mv suprsend /usr/local/bin/

Windows

Extract suprsend.exe from the downloaded .zip and move it to a directory on your PATH, such as C:\Windows\System32.

Source Build

Best for project contributors or advanced users who want to always have access to the latest binary.

Requires Go (version 1.20 or later).

# 1. Clone the repository
git clone https://github.com/suprsend/cli.git
cd cli/cmd/suprsend

# 2. Build the binary
go build -o suprsend

# 3. Move the binary to your PATH for easy access
sudo mv suprsend /usr/local/bin/

---

Step 2: Authentication

Get your service token from SuprSend Dashboard → Account Settings → Service Tokens.

Set it as an environment variable so all CLI commands can use it automatically:

Setting as Environment Variable

export SUPRSEND_SERVICE_TOKEN="your_service_token_here"

Passing tokens as flags on the command line may expose them in shell history. Environment variables are preferred for anything persistent.

---

Step 3: Enable Autocompletion (Optional)

Enable autocompletion to get command and flag suggestions with Tab and prevent typos.

---

You’re all set!

You can start using the CLI now:

npx suprsend workflow list