Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.flex.ai/llms.txt

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

Lists the compute clusters available to your organization. The Name column of the output is the value you pass to --affinity cluster=<cluster_name> when starting a training job, an interactive debug-ssh session, or an inference endpoint.

​
Usage

flexai cluster list [flags]

​
Flags

FlagShortTypeDescription
--help-hbooleanDisplays this help page.
--json-jbooleanDisplays cluster information in JSON format instead of the default ASCII table.

​
Output

Each row in the output represents one cluster:
ColumnDescription
NameThe cluster’s identifier. Use this value with --affinity cluster=<Name>.
StatusThe current operational status of the cluster.
Defaulttrue if this is the cluster FlexAI selects when no --affinity is provided and the requested --device-arch matches.
Sharedtrue if the cluster is shared across multiple organizations; false if it is dedicated to your organization.

​
Examples

​
List all available clusters

flexai cluster list

​
List clusters in JSON format

flexai cluster list --json

​
Use a listed cluster name with --affinity

flexai training run my-training-job \
  --repository-url https://github.com/flexaihq/nanoGPT/ \
  --affinity cluster=<cluster_name_from_the_list_above> \
  --accels 4 -- train.py