Use aircloud CLI

The aircloud CLI lets you inspect endpoints, open container shells, connect over SSH, and manage local CLI configuration.

Install the CLI

pip install aircloud-cli

Verify installation

aircloud --help

Expected commands include:

config
endpoints
exec
ssh
whoami

Configure the CLI

Common commands

aircloud config set <key> <value>
aircloud config get <key>
aircloud config list
aircloud config --help

Initial setup

aircloud config set api-base-url https://external.aieev.cloud:5000
aircloud config set api-key sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
aircloud config list

The CLI stores configuration in ~/.aircloud/config.json.

Check authentication context

aircloud whoami

Example output:

{
  "organization_id": "org-xxxxxxxxx",
  "project_id": "proj-yyyyyyyy",
  "api_key_id": "123456fs-4fb4-455a-b951-612df2acaafc",
  "user_id": "abc123da-85c3-4a46-asbb-4egfgc4df187",
  "authenticated_via": "api_key"
}

Inspect and manage endpoints

Available commands

aircloud endpoints list
aircloud endpoints get
aircloud endpoints start
aircloud endpoints stop
aircloud endpoints scale
aircloud endpoints patch
aircloud endpoints replicas
aircloud endpoints logs

List endpoints

aircloud endpoints list
aircloud endpoints list --search jupyter --active
aircloud endpoints list --page 2 --size 20

Get endpoint details

aircloud endpoints get <endpoint_id>

Start, stop, and scale

aircloud endpoints stop <endpoint_id>
aircloud endpoints start <endpoint_id>
aircloud endpoints scale <endpoint_id> --replicas 3

Patch a stopped endpoint

aircloud endpoints patch <endpoint_id> --command "python main.py --port 8080"
aircloud endpoints patch <endpoint_id> --port 8080
aircloud endpoints patch <endpoint_id> --health-check-path /healthz --health-check-timeout 30
aircloud endpoints patch <endpoint_id> --env MODEL_NAME=llama3 --env CUDA_VISIBLE_DEVICES=0

Patching is supported only when the endpoint is stopped.

Check replicas

aircloud endpoints replicas <endpoint_id>

View logs

aircloud endpoints logs <endpoint_id>
aircloud endpoints logs <endpoint_id> --replica-id <replica_id>
aircloud endpoints logs <endpoint_id> --start-line 1 --end-line 500
aircloud endpoints logs <endpoint_id> --list-files

Open a shell with `aircloud exec`

aircloud exec opens an interactive shell inside a running container without requiring sshd.

Open a shell

aircloud exec <endpoint_id>

Pin to a replica

aircloud exec <endpoint_id> -r <replica_id>

Use a different shell

aircloud exec <endpoint_id> -c "/bin/sh"

End the session

Type exit or press Ctrl + D.

Use `aircloud ssh`

For SSH-based access workflows, use aircloud ssh. Read Connect with SSH for image preparation, SSH key registration, and examples.

Get started

Air API

Air Container

Reference

Console

Support

Install the CLI

Verify installation

Configure the CLI

Common commands

Initial setup

Check authentication context

Inspect and manage endpoints

Available commands

List endpoints

Get endpoint details

Start, stop, and scale

Patch a stopped endpoint

Check replicas

View logs

Open a shell with `aircloud exec`

Open a shell

Pin to a replica

Use a different shell

End the session

Use `aircloud ssh`

​Install the CLI

​Verify installation

​Configure the CLI

​Common commands

​Initial setup

​Check authentication context

​Inspect and manage endpoints

​Available commands

​List endpoints

​Get endpoint details

​Start, stop, and scale

​Patch a stopped endpoint

​Check replicas

​View logs

​Open a shell with aircloud exec

​Open a shell

​Pin to a replica

​Use a different shell

​End the session

​Use aircloud ssh

Install the CLI

Verify installation

Configure the CLI

Common commands

Initial setup

Check authentication context

Inspect and manage endpoints

Available commands

List endpoints

Get endpoint details

Start, stop, and scale

Patch a stopped endpoint

Check replicas

View logs

Open a shell with `aircloud exec`

Open a shell

Pin to a replica

Use a different shell

End the session

Use `aircloud ssh`