|Docs

Overview

Sume CLI is a thin wrapper over the Sume Public API. It works for humans in a terminal and for agents through normal shell commands.

Default API base:

https://www.sume.so/api/v1

Why use the CLI

  • Human output is concise.
  • --json returns structured output for automation.
  • Commands map to public API endpoints.
  • It does not connect to Sume databases, queues, provider APIs, deployment services, or internal routes.
  • It can download safe public media URLs returned by Sume without exposing raw provider details.

Install

macOS and Linux:

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

Windows PowerShell:

irm https://cli.sume.so/install.ps1 | iex

Then authenticate:

sume login
sume me
sume credits

Common read-only commands

sume auth status
sume me --json
sume credits --json
sume jobs list --limit 5 --json
sume assets search "product demo hook" --limit 5 --json
sume assets get <asset_id> --json

Common create commands

Generation commands may spend credits. Confirm user intent before running them from an agent.

sume images generate \
  --prompt "Clean product photo on a white bathroom counter." \
  --wait \
  --json

sume videos generate \
  --prompt "Four-second vertical product demo." \
  --duration 4 \
  --resolution 480p \
  --json

sume reference-analysis create \
  --url "https://www.tiktok.com/@brand/video/1234567890" \
  --locale ko \
  --json

Agent mode

Use --json whenever another program will parse output.

sume tools list --json
sume tools schema assets.search --json
sume assets search "woman looking at camera hook" --source-type generated --limit 5 --json

Agents should summarize output and redact full URLs, request ids, user emails, workspace ids, API key ids, and large raw payloads.

Local configuration

Environment variables override local config:

export SUME_API_KEY="sume_live_..."
export SUME_API_BASE_URL="https://www.sume.so/api/v1"

Manual setup:

sume setup --api-key "$SUME_API_KEY"
sume setup --base-url "https://www.sume.so/api/v1"