Skip to main content

expanso-cli

expanso-cli​

Expanso CLI - Command-line interface for Expanso

Synopsis​

Expanso CLI is the command-line interface for interacting with Expanso.

Key Concepts:​

• Profiles: Connection configurations for different Expanso environments • Jobs: Specifications for data processing pipelines that run on edge nodes • Nodes: Edge agents connected to the control plane • Evaluations: Scheduler decisions about job assignment to nodes • Executions: Job instances running on specific nodes

Getting Started:​

  1. Save a profile to connect to the control plane: expanso-cli profile save prod --endpoint api.expanso.io --api-key exp_ak_YOUR_KEY --select

  2. List available edge nodes: expanso-cli node list

  3. Deploy a job: expanso-cli job deploy log-processor.yaml

  4. Check job status: expanso-cli job describe log-processor

  5. View executions on nodes: expanso-cli execution list --job log-processor

For shell completion setup, run 'expanso-cli completion --help'

Environment:​

EXPANSO_CLI_AUTH_API_KEY API key for authentication (exp_ak_...) (same as --api-key) EXPANSO_CLI_CONFIG_DIR Base dir for CLI config/profiles (default ~/.expanso/cli-client) EXPANSO_CLI_DESCRIPTION Profile description (same as --description) EXPANSO_CLI_ENDPOINT API endpoint URL (same as --endpoint) EXPANSO_CLI_PROFILE Profile to use (same as --profile) EXPANSO_CLI_TIMEOUT Request timeout, e.g. 30s (same as --timeout) EXPANSO_CLI_TLS_INSECURE Skip TLS certificate verification (dev only) (same as --insecure)

Prefer these over the equivalent flags for secrets: flag values are visible in ps output and in /proc/<pid>/cmdline on Linux.

Options​

      --api-key string    API key for authentication (e.g., exp_ak_...). Env: EXPANSO_CLI_AUTH_API_KEY (preferred; flag values show in ps output)
  -e, --endpoint string   API endpoint URL
  -h, --help              help for expanso-cli
  -k, --insecure          Skip TLS certificate verification
  -p, --profile string    Profile to use for configuration
      --timeout string    Request timeout duration
  -v, --verbose           Enable verbose logging

SEE ALSO​