Skip to main content

CLI

Options:

  • -h, --help Show help message and exit.

anyscale cloud

Set up and manage Anyscale clouds.

Options:

  • -h, --help Show help message and exit.

anyscale cloud config

Manage the configuration for a cloud.

Options:

  • -h, --help Show help message and exit.

anyscale cloud config get

Get the current configuration for a cloud.

Options:

  • -n, --name TEXT Cloud name to get config.
  • --cloud-id TEXT Cloud id to get config (alternative to --name).
  • -h, --help Show help message and exit.

anyscale cloud config update

Update the configuration for a cloud.

Options:

  • -n, --name TEXT Cloud name to update config.
  • --cloud-id TEXT Cloud id to update config (alternative to --name).
  • --max-stopped-instances TEXT Maximum number of stopped instances permitted in the shared instance pool.
  • -h, --help Show help message and exit.

anyscale cloud delete

Delete a cloud.

Options:

  • -n, --name TEXT Cloud name to delete.
  • --cloud-id TEXT Cloud id to delete (alternative to --name).
  • -y, --yes Don't ask for confirmation.
  • -h, --help Show help message and exit.

anyscale cloud list

List the clouds currently available in your account.

Options:

  • -h, --help Show help message and exit.

anyscale cloud set-default

Sets default cloud for your organization.

Options:

  • -n, --name TEXT Cloud name to update config.
  • --cloud-id TEXT Cloud id to delete (alternative to --name).
  • -h, --help Show help message and exit.

anyscale cloud setup

Set up a cloud provider.

anyscale cluster

Start and terminate clusters.

Options:

  • -h, --help Show help message and exit.

anyscale cluster list

List all clusters within the current project.

Options:

  • -n, --name TEXT Name of the cluster which, if provided, this prints the snapshots that were applied and commands that ran for all clusters that match this name.
  • --include-inactive List clusters of all states, including inactive ones.
  • --include-archived List both archived and unarchived clusters. Defaults to listing unarchived clusters only.
  • --max-items INTEGER Max items to show in list.
  • -h, --help Show help message and exit.

anyscale cluster start

Start a cluster on Anyscale.

Options:

  • -n, --name TEXT Name of cluster to start.
  • --env TEXT Name and version of existing cluster environment, colon-separated (if no version is specified, the latest will be used).
  • --compute TEXT Name of existing cluster compute.
  • --compute-file TEXT YAML file file specifying configs for a cluster compute (alternative to --compute).
  • --cloud TEXT Name of cloud to use for the cluster (alternative to --compute, defaults to organization default cloud).
  • --project-id TEXT Id of the project where the cluster should start (defaults to project context).
  • -h, --help Show help message and exit.

anyscale cluster terminate

Terminate a cluster on Anyscale.

Options:

  • -n, --name TEXT Name of existing cluster to terminate.
  • --cluster-id TEXT Id of existing cluster to terminate (alternative to --name).
  • --project-id TEXT Id of the project where the cluster should terminate (defaults to project context).
  • -h, --help Show help message and exit.

anyscale cluster archive

Archive a cluster on Anyscale.

Options:

  • -n, --name TEXT Name of existing cluster to archive.
  • --cluster-id TEXT Id of existing cluster to archive (alternative to --name).
  • --project-id TEXT Id of the project where the cluster should archive (defaults to project context).
  • -h, --help Show help message and exit.

anyscale cluster-env

Build and manage cluster environments.

Options:

  • -h, --help Show help message and exit.

anyscale cluster-env build [CLUSTER_ENV_FILE]

Build a new version of an existing cluster environment, or a new cluster environment (if it does not exist), based on cluster environment definition YAML.

Options:

  • -n, --name TEXT Name of cluster environment to build.
  • -h, --help Show help message and exit.

anyscale cluster-env get

Get details about cluster environment build.

Options:

  • -n, --name TEXT Name and version of cluster environment, colon-separated (if no version is specified, the latest will be used).
  • --build-id TEXT Id of cluster environment to get details (alternative to --name).
  • -h, --help Show help message and exit.

anyscale cluster-env list

List information about cluster environments on Anyscale (by default only those you have created).

Options:

  • -n, --name TEXT List information about all builds of the cluster environment with this name.
  • --build-id TEXT List information about all builds of the cluster environment with this id (alternative to --name).
  • --include-shared Include all cluster environments you have access to.
  • --max-items INTEGER Max items to show in list.
  • -h, --help Show help message and exit.

anyscale cluster-compute

Create, manage and delete cluster computes.

Options:

  • -h, --help Show help message and exit.

anyscale cluster-compute create [COMPUTE_FILE]

Create a cluster compute based on a cluster compute definition YAML.

Options:

  • -n, --name [TEXT] Name for the cluster compute to create.
  • -h, --help Show help message and exit.

anyscale cluster-compute delete

Delete the specified cluster compute.

Options:

  • -n, --name [TEXT] Name for the cluster compute to delete.
  • --cluster-compute-id TEXT Id of cluster compute to delete (alternative to --name).
  • -h, --help Show help message and exit.

anyscale cluster-compute get

Get details about cluster compute.

Options:

  • -n, --name [TEXT] Name for the cluster compute to get details.
  • --cluster-compute-id TEXT Id of cluster compute to get details (alternative to --name).
  • -h, --help Show help message and exit.

anyscale cluster-compute list

List information about cluster computes on Anyscale (by default only those you have created).

Options:

  • -n, --name TEXT List information about all the cluster computes with this name.
  • --cluster-compute-id TEXT List information about all the cluster computes with this id (alternative to --name).
  • --include-shared Include all cluster computes you have access to.
  • --max-items INTEGER Max items to show in list.
  • -h, --help Show help message and exit.

anyscale job

Submit, monitor and terminate production jobs.

anyscale job list

Display information about existing jobs.

Options:

  • -n, --name TEXT Filter by job name.
  • --job-id TEXT Filter by job id (alternative to --name).
  • --project-id TEXT Filter by project id (defaults to project context).
  • --include-all-users Include jobs not created by current user.
  • --include-archived List both archived and unarchived jobs. Defaults to listing unarchived jobs only.
  • -h, --help Show help message and exit.

anyscale job submit [JOB_CONFIG_FILE]

Submit a job to run asynchronously based on a job definition YAML.

Options:

  • -n, --name TEXT Name of job.
  • -description TEXT Description of job.
  • -h, --help Show help message and exit.

anyscale job terminate

Attempt to terminate a job asynchronously.

Options:

  • --job-id TEXT If of job.
  • -h, --help Show help message and exit.

anyscale job archive

Archive a job on Anyscale.

Options:

  • --id, --job-id TEXT If of job.
  • -n, --name TEXT Name of existing job to archive.
  • -h, --help Show help message and exit.

anyscale project

Set up and manage Anyscale projects.

anyscale project create

Create a new project.

Options:

  • -n, --name Project name.
  • -h, --help Show help message and exit.

anyscale project init

[DEPRECATED: New projects can be created with anyscale project create] Create a new project or attach this directory to an existing project.

Options:

  • -n, --name TEXT Project name for a project you wish to attach to (will be created if it does not exist).
  • --project-id TEXT Project id for an existing project you wish to attach to (alternative to --name).
  • --requirements TEXT Path to requirements.txt (created by default).
  • -h, --help Show help message and exit.

anyscale project list

List all accessible projects.

Options:

  • -h, --help Show help message and exit.

anyscale service

Deploy, monitor and terminate production services.

anyscale service deploy [SERVICE_CONFIG_FILE]

Deploy a new service based on a service definition YAML.

Options:

  • -n, --name TEXT Name of service.
  • -description TEXT Description of service.
  • -h, --help Show help message and exit.

anyscale service list

Display information about existing services.

Options:

  • -n, --name TEXT Filter by service name.
  • --service-id TEXT Filter by service id (alternative to --name).
  • --project-id TEXT Filter by project id (defaults to project context).
  • --include-all-users Include services not created by current user.
  • --include-archived List both archived and unarchived services. Defaults to listing unarchived services only.
  • -h, --help Show help message and exit.

anyscale service terminate

Attempt to terminate a service asynchronously.

Options:

  • --service-id TEXT Id of service.
  • -h, --help Show help message and exit.

anyscale service archive

Archive a service on Anyscale.

Options:

  • --id, --service-id TEXT If of service.
  • -n, --name TEXT Name of existing service to archive.
  • -h, --help Show help message and exit.

anyscale version

Display version of the Anyscale CLI.

Options:

  • -h, --help Show help message and exit.