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

Configuration

Environment variables and local configuration used by the Sume CLI.

Environment variables

VariablePurpose
SUME_API_KEYSume Developer API key.
SUME_API_BASE_URLAPI base URL. The default is https://api.sume.com/v1.
SUME_API_AUTH_MODEx-api-key or bearer.
SUME_APP_BASE_URLApp base URL for links the CLI prints. For the production API, the default is https://app.sume.com. For other APIs, the default is the origin of SUME_API_BASE_URL. sume login finds its sign-in server from the API itself.
SUME_CONFIG_DIROverrides the local config directory for tests or isolated environments.

Local config

The CLI stores the local configuration in this file:

text
~/.sume-com/config.json

Sign in to create the local config:

bash
sume login

To examine the local readiness without a call to the API, use sume doctor --agent --json.

On this page

  • Environment variables
  • Local config