Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.expanse.sh/llms.txt

Use this file to discover all available pages before exploring further.

The expanse CLI is the primary way to register compute, run workloads, and ask intelligence questions about them.

​
Installation

curl -fsSL https://expanse.org.uk/install | sh

​
Auth

​
expanse login

Sign in via your organisation’s SSO and store a personal API key locally. 
expanse login

​
expanse status

Show which identity the CLI is acting under. 
expanse status

​
Compute

​
expanse compute register

Register a new compute with your organisation. The command asks what kind of compute you’re registering and prints the install command or bootstrap snippet to run on the target. 
expanse compute register

​
Workloads

​
expanse run

Wrap a command so Expanse tracks it as a workload. Used on standalone VMs and inside SkyPilot tasks. Scheduler-backed computes capture workloads automatically; you do not need expanse run there. 
expanse run -- python train.py
expanse run -- ./my-script.sh
Anything after -- is the command to run, including its own arguments.

​
Intelligence

​
expanse analyse

Predict resource usage before a workload runs. Accepts a SLURM batch script, source file, manifest, or task file. 
expanse analyse train.slurm                 # SLURM batch script
expanse analyse train.py                    # source file
expanse analyse job.yaml                    # Kubernetes Job
expanse analyse task.yaml                   # SkyPilot task
The output is a structured prediction with median and p90 estimates for runtime, memory, CPU, and GPU, plus a suggested right-sized config.

​
expanse diagnose

Solution-oriented guidance for a failed execution. 
expanse diagnose <execution-id>
<execution-id> is the Expanse execution ID, the SLURM job ID, or the Kubernetes pod UID. The diagnosis cites the evidence it used: telemetry, logs, source bundle, and similar successful executions on your compute.

​
Other

​
expanse version

Print the CLI version. 
expanse version

​
Environment variables

VariableWhat it does
EXPANSE_API_URLOverride the control-plane URL (defaults to your organisation’s deployment)