Skip to main content

​
Setup

See our Getting Started guide for initial setup.

​
clusters create

Usage
together beta clusters create [OPTIONS]
Options
NameTypeDescription
--namestringName of the cluster
`—num-gpusnumberNumber of GPUs to allocate in the cluster
--regionenumRegion to create the cluster in. Valid regions can be found with clusters list-regions
--billing-typeON_DEMAND or RESERVEDBilling type to use for the cluster
--driver-versionenumDriver version to use for the cluster. Valid driver versions can be found with clusters list-regions
--duration-daysnumberOnly used with RESERVED billing
--gpu-typeenumGPU type to use for the cluster. Find available gpu types for each region with the clusters list-regions command.
`—cluster-typeKUBERNETES or SLURMCluster type
--volumeIDStorage volume ID to use for the cluster
--jsonOutput in JSON format

​
clusters update

Usage
together beta clusters update CLUSTER_ID [OPTIONS]
Options
NameTypeDescription
--num-gpusnumberNumber of GPUs to allocate in the cluster
`—cluster-typeKUBERNETES or SLURMCluster type
--jsonOutput in JSON format

​
clusters retrieve

Usage
together beta clusters retrieve CLUSTER_ID

​
clusters delete

Usage
together beta clusters delete CLUSTER_ID

​
clusters list

Usage
together beta clusters list CLUSTER_ID

​
clusters list-regions

Get configuration information per region to use in creating your cluster.
Usage
together beta clusters list-regions
Example Output 
{
    "regions": [
        {
            "driver_versions": [
                "CUDA_12_6_565",
                "CUDA_12_5_555",
                "CUDA_12_8_570",
                "CUDA_12_9_575",
                "CUDA_12_6_560",
                "CUDA_12_4_550"
            ],
            "name": "us-central-8",
            "supported_instance_types": [
                "H100_SXM",
                "H200_SXM"
            ]
        },
    ]
}

​
clusters get-credentials

Usage
together beta clusters get-credentials CLUSTER_ID [OPTIONS]
Options
NameTypeDescription
--filepath or -Path to write the kubeconfig to. If you pass - it will print the config to stdout instead of writing to a file. [default: ~/.kube/config]
--context-namestringName of the context to add to the kubeconfig. By default it will be the cluster name.
--overwrite-existingIf there is a conflict with the existing kubeconfig, overwrite the existing kubeconfig instead of raising an error.
--set-default-contextChange the current context for kubectl to the new context.

​
clusters storage create

Usage
together beta clusters storage create [OPTIONS]
Options
NameTypeDescription
--regionstringRegion to create the storage volume in. [required]
--size-tibnumberSize of the storage volume in TiB [required]
--volume-namestringName of the storage volume [required]
--jsonOutput in JSON format

​
clusters storage retrieve

Usage
together beta clusters storage retrieve VOLUME_ID

​
clusters storage list

Usage
together beta clusters storage list

​
clusters storage delete

Usage
together beta clusters storage delete VOLUME_ID