PricingAPI keys
  • Overview
  • Quickstart
  • Authentication
  • CLI overview
  • Install and update
  • CLI authentication
  • Command reference
  • Configuration
  • Generation workflows
  • Jobs and media inputs
  • Agent skills
  • Security
  • Troubleshooting

CLI

Install and update

Install or run the Sume CLI for current developer-platform workflows.

The recommended public install path is the hosted installer for the native sumelabs/cli binary. The binary is the sume.com developer-platform CLI for api.sume.com workflows.

Install on macOS or Linux

bash
curl https://cli.sume.com/install -fsS | bash

The installer downloads the latest release binary for your OS and architecture. Then it compares the binary with checksums.txt and installs sume in ~/.sume-com/bin. If a different sume is already on your PATH, the installer does not silently overwrite it.

Install on Windows PowerShell

powershell
irm https://cli.sume.com/install.ps1 | iex

Direct GitHub binary fallback

The names of the current release assets are sume-darwin-arm64, sume-darwin-x64, sume-linux-arm64, sume-linux-x64, and sume-windows-x64.exe. Each GitHub Release also has checksums.txt attached. For a pinned install, replace latest in the URL with a release tag such as v0.1.6.

bash
OS="$(uname -s | tr '[:upper:]' '[:lower:]')"
ARCH="$(uname -m | sed 's/x86_64/x64/;s/aarch64/arm64/')"
curl -fsSL "https://github.com/sumelabs/cli/releases/latest/download/sume-${OS}-${ARCH}" -o /tmp/sume
chmod +x /tmp/sume
sudo mv /tmp/sume /usr/local/bin/sume

Sign in

sume login uses the Sume sign-in (the same one as the hosted MCP). It opens the browser and returns to the CLI when you select Allow:

bash
sume login
sume auth status

For remote or headless environments, sign in with a code:

bash
sume login --device

Manual API-key setup stays available for CI and controlled server environments. But it is not the recommended first-run path for local users.

Development build

Run these commands from the CLI source repository:

bash
pnpm install
pnpm run build
pnpm dev -- --help

When necessary, build a local binary:

bash
pnpm run build:binary
./dist/sume --version

Verify

bash
sume version
sume doctor --agent --json
sume update --check

sume update --check shows if a newer GitHub Release exists. It does not change local files. When you decide to upgrade, run the hosted installer again.

On this page

  • Install on macOS or Linux
  • Install on Windows PowerShell
  • Direct GitHub binary fallback
  • Sign in
  • Development build
  • Verify