Skip to main content

CLI Commands

Deploy, monitor, and manage jobs running on your local edge node.

Configure CLI for Local Edge​

In each terminal you use for this project, run this from the project folder so the CLI keeps its settings there instead of in your home directory:

export EXPANSO_CLI_CONFIG_DIR="$PWD/.expanso-cli"

Then pass --endpoint http://localhost:9010 on every command, as below. The per-folder settings and the explicit endpoint keep the CLI from using a saved profile or an Expanso Cloud workspace you may have set up elsewhere.

Job Commands​

Deploy a Job​

expanso-cli job deploy my-pipeline.yaml \
  --endpoint http://localhost:9010

List Running Jobs​

expanso-cli job list --endpoint http://localhost:9010

Get Job Status​

expanso-cli job describe <job-id> \
  --endpoint http://localhost:9010

Stop a Job​

expanso-cli job stop <job-id> --endpoint http://localhost:9010

View Job Executions​

expanso-cli job executions <job-id> \
  --endpoint http://localhost:9010

Configuration Options​

Custom API Port​

Local mode listens on port 9010 by default. To change it:

expanso-edge run --local --api-listen :8080

Then pass that port to the CLI instead:

expanso-cli job list --endpoint http://localhost:8080

Data Directory​

Specify a custom location for local state:

expanso-edge run --local --data-dir ./my-data

Debug Logging​

Enable detailed execution logs:

expanso-edge run --local --log-level debug

Next Steps​