> ## Documentation Index
> Fetch the complete documentation index at: https://docs.controlplane.com/llms.txt
> Use this file to discover all available pages before exploring further.

# helm

> cpln helm — Install and manage Helm chart releases deployed on Control Plane.

Manage helm releases on cpln

Refer to the [cpln helm guide](/guides/cpln-helm) for additional details.

```none theme={null}
cpln helm [SUBCOMMAND]
```

```text theme={null}
Commands:
  cpln helm get                            Download extended information of a named release
  cpln helm history <release>              Fetch release history
  cpln helm install [release] [chart]      Install a release  [aliases: apply]
  cpln helm list                           List releases
  cpln helm rollback <release> [revision]  Roll back a release to a previous revision
  cpln helm template [release] [chart]     Generate cpln resources from a template
  cpln helm uninstall <release>            Uninstall a release  [aliases: destroy, del, delete, un]
  cpln helm upgrade [release] [chart]      Upgrade a release

Options:
  --help  Show help  [boolean]
```

***

#### helm get

Download extended information of a named release

```none theme={null}
cpln helm get [SUBCOMMAND]
```

<Note>
  An empty reference will return all references
</Note>

```text theme={null}
Commands:
  cpln helm get all <release>       Download all information for a named release
  cpln helm get manifest <release>  Download the manifest for a named release
  cpln helm get notes <release>     Download the notes for a named release
  cpln helm get values <release>    Download the values file for a named release

Options:
  --help  Show help  [boolean]
```

#### helm get all

Download all information for a named release

**Usage**

```none theme={null}
cpln helm get all <release> [OPTIONS]
```

<Accordion title="Reference">
  ```text theme={null}
  Positionals:
    release  The release name  [string] [required]

  Command options:
    --revision  get the named release with revision  [number]

  Context options:
    --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
    --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

  Format options:
    --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
    --color       Colorize the output  [boolean] [default: true]
    --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
    --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

  Request options:
    --token         Override the authorization token
    --endpoint      Override the API URL
    --insecure, -k  Ignore TLS errors  [boolean]

  Debug options:
    --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
    --debug, -d    Show all HTTP communications  [boolean] [default: false]

  Options:
    --help  Show help  [boolean]
  ```

  [Common Options Reference](/cli-reference/using-cli/common-options)
</Accordion>

***

#### helm get manifest

Download the manifest for a named release

**Usage**

```none theme={null}
cpln helm get manifest <release> [OPTIONS]
```

<Accordion title="Reference">
  ```text theme={null}
  Positionals:
    release  The release name  [string] [required]

  Command options:
    --revision  get the named release with revision  [number]

  Context options:
    --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
    --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

  Format options:
    --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
    --color       Colorize the output  [boolean] [default: true]
    --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
    --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

  Request options:
    --token         Override the authorization token
    --endpoint      Override the API URL
    --insecure, -k  Ignore TLS errors  [boolean]

  Debug options:
    --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
    --debug, -d    Show all HTTP communications  [boolean] [default: false]

  Options:
    --help  Show help  [boolean]
  ```

  [Common Options Reference](/cli-reference/using-cli/common-options)
</Accordion>

***

#### helm get notes

Download the notes for a named release

**Usage**

```none theme={null}
cpln helm get notes <release> [OPTIONS]
```

<Accordion title="Reference">
  ```text theme={null}
  Positionals:
    release  The release name  [string] [required]

  Command options:
    --revision  get the named release with revision  [number]

  Context options:
    --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
    --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

  Format options:
    --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
    --color       Colorize the output  [boolean] [default: true]
    --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
    --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

  Request options:
    --token         Override the authorization token
    --endpoint      Override the API URL
    --insecure, -k  Ignore TLS errors  [boolean]

  Debug options:
    --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
    --debug, -d    Show all HTTP communications  [boolean] [default: false]

  Options:
    --help  Show help  [boolean]
  ```

  [Common Options Reference](/cli-reference/using-cli/common-options)
</Accordion>

***

#### helm get values

Download the values file for a named release

**Usage**

```none theme={null}
cpln helm get values <release> [OPTIONS]
```

<Accordion title="Reference">
  ```text theme={null}
  Positionals:
    release  The release name  [string] [required]

  Command options:
    --all, -a   dump all (computed) values  [boolean]
    --revision  get the named release with revision  [number]

  Context options:
    --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
    --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

  Format options:
    --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
    --color       Colorize the output  [boolean] [default: true]
    --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
    --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

  Request options:
    --token         Override the authorization token
    --endpoint      Override the API URL
    --insecure, -k  Ignore TLS errors  [boolean]

  Debug options:
    --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
    --debug, -d    Show all HTTP communications  [boolean] [default: false]

  Options:
    --help  Show help  [boolean]
  ```

  [Common Options Reference](/cli-reference/using-cli/common-options)
</Accordion>

***

#### helm history

Fetch release history

**Usage**

```none theme={null}
cpln helm history <release> [OPTIONS]
```

<Accordion title="Reference">
  ```text theme={null}
  Positionals:
    release  The release name  [string] [required]

  Context options:
    --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
    --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
    --gvc      Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` command

  Format options:
    --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
    --color       Colorize the output  [boolean] [default: true]
    --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
    --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

  Request options:
    --token         Override the authorization token
    --endpoint      Override the API URL
    --insecure, -k  Ignore TLS errors  [boolean]

  Debug options:
    --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
    --debug, -d    Show all HTTP communications  [boolean] [default: false]

  Options:
    --help  Show help  [boolean]
  ```

  [Common Options Reference](/cli-reference/using-cli/common-options)
</Accordion>

***

#### helm install

Install a release

**Usage**

```none theme={null}
cpln helm install [release] [chart] [OPTIONS]
```

<Accordion title="Reference">
  ```text theme={null}
  Positionals:
    release  The release name  [string]
    chart    Path to chart  [string]

  Command options:
    --wait                      If set, will wait until all Workloads are in a ready state before marking the release as successful. It will wait for as long as --timeout  [boolean]
    --timeout                   The amount of seconds to wait for workloads to be ready before timing out. Works only if the "wait" option is set to true.  [number] [default: 300]
    --dependency-update         Update dependencies if they are missing before installing the chart  [boolean]
    --description, --desc       Add a custom description  [string]
    --generate-name, -g         Generate the name (and omit the NAME parameter)  [boolean]
    --post-renderer             The path to an executable to be used for post rendering. If it exists in $PATH, the binary will be used, otherwise it will try to look for the executable at the given path  [string]
    --post-renderer-args        An argument to the post-renderer (can specify multiple or separate values: --post-renderer-args arg1 --post-renderer-args arg2) (default [])  [default: []]
    --repo                      Chart repository url where to locate the requested chart  [string]
    --set                       Set values on the command line (can specify multiple or separate values: --set key1=val1 --set key2=val2)
    --set-string                Set STRING values on the command line (can specify multiple or separate values: --set-string key1=val1 --set-string key2=val2)
    --set-file                  Set values from respective files specified via the command line (can specify multiple or separate values: --set-file key1=path1 --set-file key2=path2)
    --values, -f                Specify values in a YAML file or a URL (can specify multiple or separate values: --values value1.yaml --values values2.yaml)  [string]
    --verify                    Verify the package before using it  [boolean]
    --version                   Specify a version constraint for the chart version to use. This constraint can be a specific tag (e.g. 1.1.1) or it may reference a valid range (e.g. ^2.0.0). If this is not specified, the latest version is used  [string]
    --username                  Chart repository username where to locate the requested chart  [string]
    --password                  Chart repository password where to locate the requested chart  [string]
    --ca-file                   Verify certificates of HTTPS-enabled servers using this CA bundle  [string]
    --cert-file                 Identify HTTPS client using this SSL certificate file  [string]
    --key-file                  Identify HTTPS client using this SSL key file  [string]
    --insecure-skip-tls-verify  Skip tls certificate checks for the chart download  [boolean]
    --render-subchart-notes     If set, render subchart notes along with the parent on install/upgrade  [boolean]
    --tag                       Attach tags (e.g., --tag drink=water)
    --remove-tag                Remove tags (e.g., --remove-tag tagname)
    --state-tag                 Attach tags to the Helm secret (e.g., --state-tag drink=water)
    --remove-state-tag          Remove tags from the Helm secret (e.g., --remove-state-tag tagname)

  Context options:
    --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
    --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
    --gvc      Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` command

  Format options:
    --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
    --color       Colorize the output  [boolean] [default: true]
    --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
    --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

  Request options:
    --token         Override the authorization token
    --endpoint      Override the API URL
    --insecure, -k  Ignore TLS errors  [boolean]

  Debug options:
    --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
    --debug, -d    Show all HTTP communications  [boolean] [default: false]

  Options:
    --help  Show help  [boolean]
  ```

  [Common Options Reference](/cli-reference/using-cli/common-options)
</Accordion>

***

#### helm list

List releases

**Usage**

```none theme={null}
cpln helm list [OPTIONS]
```

<Accordion title="Reference">
  ```text theme={null}
  Context options:
    --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
    --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command

  Format options:
    --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
    --color       Colorize the output  [boolean] [default: true]
    --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
    --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

  Request options:
    --token         Override the authorization token
    --endpoint      Override the API URL
    --insecure, -k  Ignore TLS errors  [boolean]

  Debug options:
    --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
    --debug, -d    Show all HTTP communications  [boolean] [default: false]

  Options:
    --help  Show help  [boolean]
  ```

  [Common Options Reference](/cli-reference/using-cli/common-options)
</Accordion>

***

#### helm rollback

Roll back a release to a previous revision

**Usage**

```none theme={null}
cpln helm rollback <release> [revision] [OPTIONS]
```

<Accordion title="Reference">
  ```text theme={null}
  Positionals:
    release   The release name  [string] [required]
    revision  Revision (version) number. If this argument is omitted or set to 0, it will roll back to the previous release. To see revision numbers, run 'cpln helm history RELEASE'.  [string]

  Command options:
    --cleanup-on-fail  allow deletion of new resources created in this rollback when rollback fails  [boolean] [default: false]
    --wait             If set, will wait until all Workloads are in a ready state before marking the release as successful. It will wait for as long as --timeout  [boolean]
    --timeout          The amount of seconds to wait for workloads to be ready before timing out. Works only if the "wait" option is set to true.  [number] [default: 300]

  Context options:
    --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
    --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
    --gvc      Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` command

  Format options:
    --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
    --color       Colorize the output  [boolean] [default: true]
    --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
    --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

  Request options:
    --token         Override the authorization token
    --endpoint      Override the API URL
    --insecure, -k  Ignore TLS errors  [boolean]

  Debug options:
    --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
    --debug, -d    Show all HTTP communications  [boolean] [default: false]

  Options:
    --help  Show help  [boolean]
  ```

  [Common Options Reference](/cli-reference/using-cli/common-options)
</Accordion>

***

#### helm template

Generate cpln resources from a template

**Usage**

```none theme={null}
cpln helm template [release] [chart] [OPTIONS]
```

<Accordion title="Reference">
  ```text theme={null}
  Positionals:
    release  The release name  [string]
    chart    Path to chart  [string]

  Command options:
    --dependency-update         Update dependencies if they are missing before installing the chart  [boolean]
    --description, --desc       Add a custom description  [string]
    --generate-name, -g         Generate the name (and omit the NAME parameter)  [boolean]
    --post-renderer             The path to an executable to be used for post rendering. If it exists in $PATH, the binary will be used, otherwise it will try to look for the executable at the given path  [string]
    --post-renderer-args        An argument to the post-renderer (can specify multiple or separate values: --post-renderer-args arg1 --post-renderer-args arg2) (default [])  [default: []]
    --repo                      Chart repository url where to locate the requested chart  [string]
    --set                       Set values on the command line (can specify multiple or separate values: --set key1=val1 --set key2=val2)
    --set-string                Set STRING values on the command line (can specify multiple or separate values: --set-string key1=val1 --set-string key2=val2)
    --set-file                  Set values from respective files specified via the command line (can specify multiple or separate values: --set-file key1=path1 --set-file key2=path2)
    --values, -f                Specify values in a YAML file or a URL (can specify multiple or separate values: --values value1.yaml --values values2.yaml)  [string]
    --verify                    Verify the package before using it  [boolean]
    --version                   Specify a version constraint for the chart version to use. This constraint can be a specific tag (e.g. 1.1.1) or it may reference a valid range (e.g. ^2.0.0). If this is not specified, the latest version is used  [string]
    --username                  Chart repository username where to locate the requested chart  [string]
    --password                  Chart repository password where to locate the requested chart  [string]
    --ca-file                   Verify certificates of HTTPS-enabled servers using this CA bundle  [string]
    --cert-file                 Identify HTTPS client using this SSL certificate file  [string]
    --key-file                  Identify HTTPS client using this SSL key file  [string]
    --insecure-skip-tls-verify  Skip tls certificate checks for the chart download  [boolean]
    --render-subchart-notes     If set, render subchart notes along with the parent on install/upgrade  [boolean]
    --namespace, -n             Specify the Kubernetes namespace for exporting in CRD format (applicable only with '--output crd').
    --keep, -k                  Prevent deletion of the corresponding Control Plane resource (only when using '--output crd').  [boolean]

  Context options:
    --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
    --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
    --gvc      Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` command

  Format options:
    --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
    --color       Colorize the output  [boolean] [default: true]
    --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
    --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

  Request options:
    --token         Override the authorization token
    --endpoint      Override the API URL
    --insecure, -k  Ignore TLS errors  [boolean]

  Debug options:
    --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
    --debug, -d    Show all HTTP communications  [boolean] [default: false]

  Options:
    --help  Show help  [boolean]
  ```

  [Common Options Reference](/cli-reference/using-cli/common-options)
</Accordion>

***

#### helm uninstall

Uninstall a release

**Usage**

```none theme={null}
cpln helm uninstall <release> [OPTIONS]
```

<Accordion title="Reference">
  ```text theme={null}
  Positionals:
    release  The release name  [string] [required]

  Request options:
    --token             Override the authorization token
    --endpoint          Override the API URL
    --insecure, -k, -k  Ignore TLS errors  [boolean]

  Context options:
    --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
    --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
    --gvc      Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` command

  Format options:
    --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
    --color       Colorize the output  [boolean] [default: true]
    --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
    --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

  Debug options:
    --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
    --debug, -d    Show all HTTP communications  [boolean] [default: false]

  Options:
    --help  Show help  [boolean]
  ```

  [Common Options Reference](/cli-reference/using-cli/common-options)
</Accordion>

***

#### helm upgrade

Upgrade a release

**Usage**

```none theme={null}
cpln helm upgrade [release] [chart] [OPTIONS]
```

<Accordion title="Reference">
  ```text theme={null}
  Positionals:
    release  The release name  [string]
    chart    Path to chart  [string]

  Command options:
    --wait                      If set, will wait until all Workloads are in a ready state before marking the release as successful. It will wait for as long as --timeout  [boolean]
    --timeout                   The amount of seconds to wait for workloads to be ready before timing out. Works only if the "wait" option is set to true.  [number] [default: 300]
    --history-limit             Maximum number of revisions saved per release. Use 0 for no limit  [number] [default: 10]
    --install                   If a release by this name doesn't already exist, run an install  [boolean]
    --dependency-update         Update dependencies if they are missing before installing the chart  [boolean]
    --description, --desc       Add a custom description  [string]
    --generate-name, -g         Generate the name (and omit the NAME parameter)  [boolean]
    --post-renderer             The path to an executable to be used for post rendering. If it exists in $PATH, the binary will be used, otherwise it will try to look for the executable at the given path  [string]
    --post-renderer-args        An argument to the post-renderer (can specify multiple or separate values: --post-renderer-args arg1 --post-renderer-args arg2) (default [])  [default: []]
    --repo                      Chart repository url where to locate the requested chart  [string]
    --set                       Set values on the command line (can specify multiple or separate values: --set key1=val1 --set key2=val2)
    --set-string                Set STRING values on the command line (can specify multiple or separate values: --set-string key1=val1 --set-string key2=val2)
    --set-file                  Set values from respective files specified via the command line (can specify multiple or separate values: --set-file key1=path1 --set-file key2=path2)
    --values, -f                Specify values in a YAML file or a URL (can specify multiple or separate values: --values value1.yaml --values values2.yaml)  [string]
    --verify                    Verify the package before using it  [boolean]
    --version                   Specify a version constraint for the chart version to use. This constraint can be a specific tag (e.g. 1.1.1) or it may reference a valid range (e.g. ^2.0.0). If this is not specified, the latest version is used  [string]
    --username                  Chart repository username where to locate the requested chart  [string]
    --password                  Chart repository password where to locate the requested chart  [string]
    --ca-file                   Verify certificates of HTTPS-enabled servers using this CA bundle  [string]
    --cert-file                 Identify HTTPS client using this SSL certificate file  [string]
    --key-file                  Identify HTTPS client using this SSL key file  [string]
    --insecure-skip-tls-verify  Skip tls certificate checks for the chart download  [boolean]
    --render-subchart-notes     If set, render subchart notes along with the parent on install/upgrade  [boolean]
    --tag                       Attach tags (e.g., --tag drink=water)
    --remove-tag                Remove tags (e.g., --remove-tag tagname)
    --state-tag                 Attach tags to the Helm secret (e.g., --state-tag drink=water)
    --remove-state-tag          Remove tags from the Helm secret (e.g., --remove-state-tag tagname)

  Context options:
    --profile  Override the profile. The default profile can be set using the `cpln profile set-default` command or by setting the CPLN_PROFILE environment variable
    --org      Override the organization. The default organization can be set in your profile by using the `cpln profile update` command
    --gvc      Override the global virtual cloud. The default global virtual cloud can be set in your profile by using the `cpln profile update` command

  Format options:
    --output, -o  Set the output format  [choices: "text", "json", "yaml", "json-slim", "yaml-slim", "tf", "crd", "names"]
    --color       Colorize the output  [boolean] [default: true]
    --ts          Timestamp format if the output format is text (e.g., --output=text)  [choices: "iso", "local", "age"]
    --max         Maximum number of records to show. A value less than 1 will return all records.  [number] [default: 50]

  Request options:
    --token         Override the authorization token
    --endpoint      Override the API URL
    --insecure, -k  Ignore TLS errors  [boolean]

  Debug options:
    --verbose, -v  Enable verbose output to stderr  [boolean] [default: false]
    --debug, -d    Show all HTTP communications  [boolean] [default: false]

  Options:
    --help  Show help  [boolean]
  ```

  [Common Options Reference](/cli-reference/using-cli/common-options)
</Accordion>

***