Helm commands

Helm 4 command lines from the command reference and guides of the Helm 4.3 documentation, grouped by task: repositories, installing, upgrading and rolling back, inspecting releases, chart development, dependencies, OCI registries and plugins. Capitals such as NAME, RELEASE and CHART are placeholders; lowercase names like myredis or happy-panda are the documentation's sample values. Rows that begin with a dash are options to add to a command. Two Helm 3 flags, --atomic and --force, have new names in Helm 4.

185 commands in 11 sections. Checked row by row against Helm 4.3 documentation: helm (command reference index) on . Edited by Jay.

Inspecting and downloading charts 13

CommandWhat it does
helm showChart information command groupIts subcommands print the values, Chart.yaml, README or CRDs of a chart directory, archive or URL.
helm show values CHARTShow a chart's default valuesPrints the chart's values.yaml, the settings that --values and --set override.
helm show chart CHARTShow the chart definitionPrints Chart.yaml as stored in the chart directory, archive or URL you name.
helm show readme CHARTShow the chart READMEPrints the README file shipped inside the chart.
helm show crds CHARTShow the chart's CRDsPrints the CustomResourceDefinition files that the chart carries.
helm show all CHARTShow all chart informationPrints values.yaml, Chart.yaml and the README one after another.
helm pull CHARTDownload a chart archiveSaves the packaged chart locally without installing it, for inspection or repackaging.
helm pull chartrepo/chartnameDownload a chart from a repositoryThe chart is named as the repository's local name, a slash, then the chart name.
helm pull CHART --untar=trueDownload and unpack a chartExtracts the archive into a directory once the download has finished.
helm pull CHART --destination DIRChoose the download folderSets where the archive is written; the default is the current directory and -d is the short flag.
helm pull CHART --verifyVerify a chart on downloadRequires a provenance file; if verification fails, nothing is saved locally.
helm pull CHART --version NUMBERDownload a specific chart versionWithout it the latest version is fetched; the value may also be a version range.
helm verify PATHVerify a signed chartConfirms a local chart archive against its provenance file and the keyring.

Installing and uninstalling 24

When --values and --set are both given, the --set values are merged in with higher precedence; overrides made with --set are persisted in a Secret.

CommandWhat it does
helm install NAME CHARTInstall a chartCreates a release called NAME from a chart reference, archive, directory or URL.
helm install NAME CHART --namespace NAMESPACEInstall into a namespaceThe release is created in the named namespace instead of the current one.
helm install NAME CHART --create-namespaceCreate the namespace on installCombine with --namespace so that a namespace that does not exist yet is created first.
helm install NAME CHART --values FILEInstall with a values fileThe YAML file or URL overrides the chart's default values; -f is the short flag.
helm install -f myvalues.yaml -f override.yaml myredis ./redisLayer several values filesWhen two files set the same key, the right-most file wins.
helm install NAME CHART --set key1=val1,key2=val2Override individual valuesComma-separated pairs set several keys at once; they take precedence over values given with --values.
helm install --set-string long_int=1234567890 myredis ./redisForce a value to a stringUse when a value that looks like a number must stay a string.
helm install --set-file my_script=dothings.sh myredis ./redisSet a value from a fileThe key receives the file's content, which suits values too long for the command line.
helm install NAME CHART --dry-run=client --debugPreview an installPrints the rendered manifests without creating a release and without connecting to the cluster.
helm install NAME CHART --verifyVerify the chart before installThe chart must have a provenance file that passes every verification step.
helm install NAME CHART --dependency-updateFetch missing dependencies firstDownloads chart dependencies that are absent before the install starts.
helm install NAME CHART --force-replaceForce replacement of resourcesHelm 4 name of the old --force flag, which still works but prints a deprecation warning.
helm install -f values.yaml bitnami/wordpress --generate-nameLet Helm name the releaseWith --generate-name the NAME argument is left out and a name is generated.
helm install mymaria example/mariadbInstall from an added repositoryexample is the repository's local name and mariadb the chart inside it.
helm install mynginx ./nginx-1.2.3.tgzInstall a packaged chart fileThe chart is read from a local .tgz archive.
helm install mynginx ./nginxInstall an unpacked chart directory
helm install mynginx https://example.com/charts/nginx-1.2.3.tgzInstall from a chart URLThe archive is downloaded from the absolute URL you give.
helm install --repo https://example.com/charts/ mynginx nginxInstall from a repository URLThe chart name is looked up in the repository at that address rather than in a locally added one.
helm uninstall RELEASEUninstall a releaseDeletes the release's resources and, by default, its history, which frees the name for reuse.
helm uninstall RELEASE --namespace NAMESPACEUninstall from a namespaceNeeded when the release does not live in the current namespace.
helm uninstall --keep-historyUninstall but keep historyThe deletion record is kept and the release appears under helm list --uninstalled.
helm uninstall RELEASE --dry-runPreview an uninstallShows which releases would be removed without removing them.
helm uninstall RELEASE --cascade foreground --waitWait for dependents to be deletedReturns only after resources that carry finalizers are completely gone.
helm uninstall RELEASE --ignore-not-foundIgnore a missing releaseExits successfully even when no release of that name exists.

Upgrading and rolling back 13

Helm 4 renamed two common flags: --atomic is now --rollback-on-failure and --force is now --force-replace. The old spellings still work but print a deprecation warning.

CommandWhat it does
helm upgrade RELEASE CHARTUpgrade a releaseApplies a new chart version or changed values and records a new revision.
helm upgrade --install RELEASE CHARTInstall or upgrade in one stepRuns an install when no release of that name exists, otherwise upgrades it; -i is the short flag.
helm upgrade --install RELEASE CHART --create-namespaceCreate the release namespaceOnly has an effect together with --install, when the release is installed for the first time.
helm upgrade RELEASE CHART --rollback-on-failureRoll back a failed upgradeReturns to the previous successful release automatically; replaces the --atomic flag of Helm 3.
helm upgrade RELEASE CHART --dependency-updateUpdate dependencies before upgradingFetches chart dependencies that are missing before the upgrade runs.
helm upgrade RELEASE CHART --version VERSIONUpgrade to a chart versionAccepts an exact version or a range; without it the latest version is used.
helm upgrade RELEASE CHART --values FILEUpgrade with a values fileGive the flag several times to combine files; later files take priority.
helm upgrade RELEASE CHART --set key1=val1,key2=val2Override values during an upgradeWhen the same key is set twice, the right-most --set wins.
helm upgrade RELEASE CHART --force-replaceForce replacement on upgradeWas called --force in Helm 3.
helm upgrade --reuse-values --set foo=bar --set foo=newbar redis ./redisReuse the last release's valuesKeeps the values of the previous release and merges the new --set overrides into them.
helm rollback RELEASE REVISIONRoll back to a revisionLeave the revision out, or pass 0, to return to the previous release.
helm rollback happy-panda 1Roll back to the first revisionRevision numbers start at 1 and grow with every install, upgrade and rollback.
helm rollback RELEASE REVISION --cleanup-on-failClean up after a failed rollbackLets Helm delete resources the rollback created if it does not succeed.

Install and upgrade options 16

CommandWhat it does
--waitWait until resources are readyOn install, upgrade and rollback: the release is marked failed if readiness is not reached within --timeout.
--timeout DURATIONSet the operation timeoutA Go duration such as 5m0s, the default, applied to each Kubernetes operation.
--dry-run=serverSimulate against the clusterUnlike --dry-run=client it needs cluster connectivity, and lookup calls in templates are executed.
--no-hooksSkip chart hooksAccepted by install, upgrade, rollback and uninstall; hook resources are not run for that command.
--wait-for-jobsWait for Jobs to completeUsed together with --wait: the release counts as successful only once all Jobs have finished.
--reset-valuesReset values to chart defaultsOn upgrade, drops values carried over from the previous release and starts from the chart's built-in ones.
--reset-then-reuse-valuesReset, then reapply last valuesOn upgrade, starts from the chart defaults, applies the previous release's values and then the new overrides.
--history-max INTLimit stored revisionsUpgrade and rollback option: caps the revisions kept per release at the number given; default 10, 0 for no limit.
--server-sideChoose server-side applyTakes true, false or auto on upgrade; auto follows the method the previous release used.
--force-conflictsOverride apply conflictsOnly relevant with server-side apply: Helm's changes win when a conflict is reported.
--take-ownershipAdopt existing resourcesLets install or upgrade manage resources that already exist without Helm's ownership annotations.
--skip-crdsSkip CRD installationBy default the CRDs a chart ships are installed when they are not present yet.
--hide-secretHide Secrets in dry-run outputDry-run output otherwise includes Secret manifests, which can contain sensitive values.
--set-jsonSet values as JSONTakes key=jsonvalue pairs or a single JSON object covering several keys.
--develAllow development versionsAlso considers pre-release chart versions; ignored when --version is given.
--post-renderer PLUGINPost-render with a pluginHelm 4 takes the name of a post-renderer plugin here, no longer a path to an executable.

Inspecting releases 29

helm list returns at most 256 releases unless --max says otherwise; --max 0 hands the limit to the server default rather than returning everything.

CommandWhat it does
helm listList releasesCovers the current namespace and shows each release's revision, status and chart.
helm lsList releases (short alias)Same command as helm list under a shorter name.
helm list --all-namespacesList releases in all namespaces-A is the short form of the flag.
helm list -l key1=value1,key2=value2Filter releases by labelThe label selector supports the =, == and != operators; several conditions are separated by commas.
helm list --filter 'ara[a-z]+'Filter releases by name patternThe pattern is a Perl-compatible regular expression matched against release names.
helm list --dateSort releases by dateThe default order is alphabetical by release name.
helm list --deployedShow deployed releases onlyWithout a status filter the list contains releases in every status.
helm list --pendingShow pending releases
helm list --failedShow failed releases
helm list --uninstalledShow uninstalled releasesLists only releases removed with the --keep-history flag.
helm list --supersededShow superseded releases
helm list -o yamlPrint the list as YAMLThe output flag also accepts table, the default, and json.
helm status RELEASEShow release statusReports the last deployment time, namespace, state, revision and the chart's notes.
helm status RELEASE --revision NUMBERShow status of a revisionLooks at an earlier revision of the release rather than the latest one.
helm history RELEASEShow revision historyLists each revision with its date, status, chart and description; at most 256 by default.
helm history RELEASE --show-rollback-revisionShow rollback targets in historyAdds a ROLLBACK column naming the revision each rollback went back to.
helm history RELEASE --max INTLimit the history lengthReturns at most that many revisions; the default is 256.
helm getRelease details command groupSubcommands fetch a release's values, manifest, notes, hooks or metadata.
helm get values RELEASEShow user-supplied valuesPrints the overrides given at install or upgrade time; add -o json or -o yaml for other formats.
helm get values RELEASE --allShow all computed valuesPrints the full computed set rather than only the overrides; -a is the short flag.
helm get manifest RELEASEShow the release manifestPrints the Kubernetes resources generated from the chart and its dependencies as YAML.
helm get manifest RELEASE --revision INTShow an earlier manifestFetches the manifest of the given revision; the other get subcommands accept the same flag.
helm get notes RELEASEShow the release notesReprints the chart's NOTES text that appeared after the install.
helm get hooks RELEASEShow the release hooksHooks come out as YAML documents separated by --- lines.
helm get all RELEASEShow everything about a releaseOne output with the manifest, hooks, notes and the values that were supplied.
helm get metadata RELEASEShow release metadata
helm test RELEASERun a release's testsRuns the tests defined in the installed chart against a deployed release.
helm test RELEASE --logsRun tests and print pod logsLogs are collected once every test has finished and before cleanup.
helm test RELEASE --filter name=test1,name=test2Run selected tests onlyTests are chosen by name; a leading ! excludes a test.

Chart development 21

CommandWhat it does
helm create NAMEScaffold a new chartMakes a directory holding Chart.yaml, values.yaml, templates/ and charts/ as a starting point.
helm create my-chart --starter starter-nameCreate from a starter chart-p is the short flag; it also accepts an absolute path to a starter.
helm lint PATHCheck a chart for problemsReports [ERROR] for anything that would break installation and [WARNING] for departures from convention.
helm lint PATH --quietShow only lint warnings and errorsInformational messages are left out of the report.
helm lint PATH --strictFail lint on warningsWarnings then make the command fail, not only errors.
helm lint PATH --with-subchartsLint dependent charts tooExtends the check to the chart's dependencies.
helm template NAME CHARTRender templates locallyPrints the rendered manifests without contacting the cluster; in-cluster lookups are faked.
helm template --debugRender with debug output
helm template --api-versions networking.k8s.io/v1,cert-manager.io/v1 mychart ./mychartRender for given API versionsFills Capabilities.APIVersions; the flag takes a comma-separated list or can be repeated.
--show-onlyRender selected templates onlyA helm template option, short form -s, that limits the output to the template files you name.
--output-dirWrite rendered files to a folderA helm template option: manifests go to files in that directory rather than to standard output.
--include-crdsInclude CRDs in rendered outputA helm template option that adds the chart's CRD files to what is rendered.
--kube-versionSet the target Kubernetes versionAccepted by helm template and helm lint; fills Capabilities.KubeVersion for the rendering.
--is-upgradeRender as an upgradeA helm template option: templates then see Release.IsUpgrade as true in place of Release.IsInstall.
helm package CHART_PATHPackage a chartProduces a versioned .tgz archive from a directory that contains Chart.yaml.
helm package CHART_PATH --app-version VERSIONSet appVersion when packagingOverrides the appVersion field of Chart.yaml in the archive that is built.
helm package CHART_PATH --dependency-updateUpdate dependencies while packagingRefreshes the charts/ directory from Chart.yaml first; -u is the short flag.
helm package CHART_PATH --destination DIRChoose the archive output folderThe archive is written to the current directory unless this is set; -d is the short flag.
helm package CHART_PATH --version VERSIONSet the chart version when packagingMust be a semantic version; it replaces the version read from Chart.yaml.
helm package --sign ./mychart --key mykey --keyring ~/.gnupg/secring.gpgPackage and sign a chartSigns with the named PGP key and writes a provenance file next to the archive.
SOURCE_DATE_EPOCH=1609459200 helm package ./mychartBuild a reproducible archiveEvery file in the archive gets that Unix timestamp as its modification time.

Dependencies 7

CommandWhat it does
helm dependencyDependency command groupIts subcommands keep the charts/ directory in step with the dependencies declared in Chart.yaml.
helm dependency update CHARTUpdate chart dependenciesDownloads the charts listed in Chart.yaml into charts/ and writes a lock file.
helm dep up foochartUpdate dependencies (short form)Shorter spelling of helm dependency update, as used in the charts guide.
helm dependency update CHART --skip-refreshSkip the repository refreshUses the local repository cache as it stands, without downloading the indexes again.
helm dependency update CHART --verifyVerify downloaded dependenciesEach downloaded dependency is checked against its signature.
helm dependency build CHARTRebuild from the lock fileRestores charts/ to the exact versions recorded in Chart.lock; without a lock file it behaves like update.
helm dependency list CHARTList chart dependenciesWorks on a chart directory or archive and changes nothing.

OCI registries 13

helm push only uploads .tgz files that helm package has already created, and its target must begin with oci://.

CommandWhat it does
helm registryRegistry command groupHolds the login and logout subcommands for OCI registries.
helm registry login HOSTLog in to a registryGive the hostname only, optionally with a port; Helm 4 rejects a full URL here.
helm registry login -u myuser localhost:5000Log in with a user nameHelm then asks for the password interactively.
echo "$GITHUB_TOKEN" | helm registry login ghcr.io -u $GITHUB_USER --password-stdinLog in with a piped tokenThe password or identity token is read from standard input.
helm registry logout HOSTLog out of a registryDeletes the credentials saved for that host.
helm push CHART REMOTEUpload a chart archiveA provenance file that belongs to the chart is uploaded with it.
helm push mychart-0.1.0.tgz oci://localhost:5000/helm-chartsPush a packaged chart to OCIThe reference starts with oci:// and leaves out the chart name and tag.
helm pull oci://localhost:5000/helm-charts/mychart --version 0.1.0Pull a chart from a registryHere the reference includes the chart name, and the version is given with --version.
helm show all oci://localhost:5000/helm-charts/mychart --version 0.1.0Inspect a chart in a registry
helm template myrelease oci://localhost:5000/helm-charts/mychart --version 0.1.0Render a chart from a registry
helm install myrelease oci://localhost:5000/helm-charts/mychart --version 0.1.0Install a chart from a registry
helm upgrade myrelease oci://localhost:5000/helm-charts/mychart --version 0.2.0Upgrade from a registry chart
helm install myapp oci://registry.example.com/charts/app@sha256:abc123...Install a chart by digestNew in Helm 4: a chart whose digest does not match is not installed.

Plugins 9

CommandWhat it does
helm pluginPlugin command groupManages client-side plugins: install, list, update, uninstall, package and verify.
helm plugin install PATH/URLInstall a pluginTakes a local path or the URL of a VCS repository or plugin tarball.
helm plugin install https://github.com/adamreese/helm-envInstall a plugin from GitHubThe plugin is cloned or copied into the directory that $HELM_PLUGINS points to.
helm plugin install URL --version VERSIONInstall a specific plugin versionAccepts a version constraint; the newest version is used when the flag is absent.
helm plugin listList installed pluginsAdd --type to show plugins of a single type only.
helm plugin update PLUGINUpdate a pluginSeveral plugin names can be given at once.
helm plugin uninstall PLUGINUninstall a pluginAccepts more than one plugin name.
helm plugin package PATHPackage a pluginProduces a tarball plus, unless --sign=false is given, a PGP-signed provenance file.
helm plugin verify PATHVerify a signed pluginWorks on plugin tarballs and on installed plugin directories.

Environment, help and completion 20

CommandWhat it does
helm envShow Helm's environmentShows the values in effect, including defaults for variables that are not set, such as HELM_PLUGINS.
helm env HELM_PLUGINSPrint the plugins directoryOutputs just the path where plugins are installed.
helm versionShow the Helm versionPrints the release version together with the Git commit, tree state and Go version of the build.
helm version --shortPrint only the version number
helm version --template='Version: {{.Version}}'Format the version outputThe Go template can use .Version, .GitCommit, .GitTreeState and .GoVersion.
helm helpShow built-in help
helm get -hShow help for one commandAny command followed by -h prints its own usage and flags.
--namespaceSet the namespace for a commandGlobal flag, short form -n; without it Helm uses the namespace of the current kubeconfig context.
--kube-contextUse another kubeconfig contextGlobal flag; the HELM_KUBECONTEXT variable sets the same thing.
--kubeconfigUse another kubeconfig fileGlobal flag with the file's path; the KUBECONFIG variable is the alternative.
--debugPrint debug outputGlobal flag that turns on verbose logging for any command.
helm completionCompletion command groupHas one subcommand per supported shell: bash, fish, powershell and zsh.
helm completion bashPrint the bash completion scriptRedirect the output to /etc/bash_completion.d/helm on Linux to load it in every new session.
source <(helm completion bash)Load bash completion nowAffects only the shell session in which it is run.
helm completion zshPrint the zsh completion script
helm completion zsh > "${fpath[1]}/_helm"Install zsh completion permanentlyRun once; the script is picked up by every new zsh session.
helm completion fishPrint the fish completion scriptSaving it to ~/.config/fish/completions/helm.fish enables it for new shells.
helm completion fish | sourceLoad fish completion nowApplies to the fish session that is open at the moment.
helm completion powershellPrint the PowerShell completion scriptAdd the script's output to your PowerShell profile to load it in every session.
helm completion powershell | Out-String | Invoke-ExpressionLoad PowerShell completion now

Notes

Finding and inspecting charts

helm repo add NAME URL registers a chart repository and helm repo update refreshes the locally cached chart information — run it before searching, because helm search repo KEYWORD reads that local cache and not the network. The search shows the latest stable version of each matching chart. Before installing anything, helm show values CHART prints the chart's default values file, which is the document to read and override; save your overrides to a YAML file and pass it with --values rather than stacking dozens of --set flags.

Install, render, upgrade

helm template NAME CHART renders the manifests locally with your values without touching the cluster; it skips the server-side validity checks, so it proves the templates render, not that the cluster will accept them. helm install NAME CHART creates the release; helm upgrade RELEASE CHART applies changed values or a new chart version, and helm upgrade --install RELEASE CHART does whichever of the two is needed, which suits CI pipelines. In Helm 4 the dry-run flag takes a value: helm install NAME CHART --dry-run=client --debug stays off the cluster, while --dry-run=server simulates the operation on the server.

Releases and rollback

helm list shows releases in the current namespace with revision numbers and status; -A covers all namespaces. Every install, upgrade and rollback creates a revision, helm history RELEASE lists them, and helm rollback RELEASE REVISION returns to one — the fast path out of a bad deploy. helm uninstall RELEASE removes the release, its resources and its history; use helm uninstall --keep-history if you want the record to stay.

Questions

What is the difference between helm install and helm upgrade --install?

helm install NAME CHART creates a new release. helm upgrade --install RELEASE CHART first checks whether the release exists: if it does not, Helm runs an install, and if it does, the existing release is upgraded. One command therefore covers both cases.

How do I roll back a Helm release?

helm history RELEASE lists the revision numbers and helm rollback RELEASE REVISION returns to the one you pick. Leave the revision out, or pass 0, to go back to the previous release.

How do I see the values a release was installed with?

helm get values RELEASE prints the values supplied by the user and helm get values RELEASE --all prints the full computed set. helm show values CHART shows the defaults of the chart itself.

What replaced --atomic in Helm 4?

The flag is now --rollback-on-failure, as in helm upgrade RELEASE CHART --rollback-on-failure, and --force became --force-replace. The Helm 3 spellings remain but emit a deprecation warning.

Does helm uninstall keep the release history?

No. helm uninstall RELEASE removes the release record together with the resources. helm uninstall --keep-history keeps the record, and helm list --uninstalled then shows such releases.

Sources and checks

38 more source pages

Every row on this page was matched to a line in the documentation above on . A binding that could not be found there is not listed.

Found a wrong or missing key? Tell us and it gets checked against the source. How we verify describes the process and its limits.