@zuke/helm

`@zuke/helm` — typed `HelmTasks` wrappers for the [Helm](https://helm.sh) CLI,

Symbols

# HelmDependencyUpdateSettings class

class HelmDependencyUpdateSettings extends HelmSettings

Settings for helm dependency update.

Member	Signature	Doc
`chart`	`chart(path: PathLike): this`	The chart path whose dependencies to update (required).

# HelmInstallSettings class

class HelmInstallSettings extends HelmValuesSettings

Settings for helm install.

Member	Signature	Doc
`release`	`release(name: string): this`	The release name (required).
`chart`	`chart(ref: string): this`	The chart reference or path (required).
`createNamespace`	`createNamespace(): this`	Create the release namespace if absent (`--create-namespace`).
`wait`	`wait(): this`	Wait until resources are ready (`--wait`).
`atomic`	`atomic(): this`	Roll back on failure (`--atomic`).
`timeout`	`timeout(duration: string): this`	Operation timeout, e.g. `5m` (`--timeout`).
`dryRun`	`dryRun(): this`	Simulate the install (`--dry-run`).

# HelmLintSettings class

class HelmLintSettings extends HelmSettings

Settings for helm lint.

Member	Signature	Doc
`chart`	`chart(path: PathLike): this`	The chart path to lint (required).
`values`	`values(path: PathLike): this`	Add a values file (`--values`); repeatable.
`strict`	`strict(): this`	Treat warnings as errors (`--strict`).

# HelmPackageSettings class

class HelmPackageSettings extends HelmSettings

Settings for helm package.

Member	Signature	Doc
`chart`	`chart(path: PathLike): this`	The chart path to package (required).
`destination`	`destination(path: PathLike): this`	Output directory for the packaged chart (`--destination`).
`version`	`version(value: string): this`	Set the chart version (`--version`).
`appVersion`	`appVersion(value: string): this`	Set the chart appVersion (`--app-version`).

# HelmRepoAddSettings class

class HelmRepoAddSettings extends HelmSettings

Settings for helm repo add.

Member	Signature	Doc
`name`	`name(value: string): this`	The repository name (required).
`url`	`url(value: string): this`	The repository URL (required).

# HelmSettings class

class HelmSettings extends ToolSettings

Base for all helm subcommand settings: the binary is helm, and the cluster-targeting flags (--namespace, --kube-context, --kubeconfig) are shared by every subcommand.

Member	Signature	Doc
`namespace`	`namespace(name: string): this`	Target a namespace (`--namespace`).
`kubeContext`	`kubeContext(name: string): this`	Use a named kube context (`--kube-context`).
`kubeconfig`	`kubeconfig(path: PathLike): this`	Use an explicit kubeconfig file (`--kubeconfig`).

# HelmTasks const

const HelmTasks: HelmTasksApi

Typed task functions for the helm CLI.

# HelmTasksApi interface

interface HelmTasksApi

The shape of HelmTasks.

Member	Signature	Doc
`install`	`install(configure?: Configure<HelmInstallSettings>): Promise<CommandOutput>`	Install a chart: `helm install`.
`upgrade`	`upgrade(configure?: Configure<HelmUpgradeSettings>): Promise<CommandOutput>`	Upgrade (or install) a release: `helm upgrade`.
`uninstall`	`uninstall(configure?: Configure<HelmUninstallSettings>): Promise<CommandOutput>`	Uninstall a release: `helm uninstall`.
`template`	`template(configure?: Configure<HelmTemplateSettings>): Promise<CommandOutput>`	Render manifests locally: `helm template`.
`lint`	`lint(configure?: Configure<HelmLintSettings>): Promise<CommandOutput>`	Lint a chart: `helm lint`.
`dependencyUpdate`	`dependencyUpdate(configure?: Configure<HelmDependencyUpdateSettings>): Promise<CommandOutput>`	Update chart dependencies: `helm dependency update`.
`repoAdd`	`repoAdd(configure?: Configure<HelmRepoAddSettings>): Promise<CommandOutput>`	Add a chart repository: `helm repo add`.
`package`	`package(configure?: Configure<HelmPackageSettings>): Promise<CommandOutput>`	Package a chart: `helm package`.

# HelmTemplateSettings class

class HelmTemplateSettings extends HelmValuesSettings

Settings for helm template (render manifests locally).

Member	Signature	Doc
`release`	`release(name: string): this`	The release name (required).
`chart`	`chart(ref: string): this`	The chart reference or path (required).
`outputDir`	`outputDir(path: PathLike): this`	Write rendered manifests to a directory (`--output-dir`).

# HelmUninstallSettings class

class HelmUninstallSettings extends HelmSettings

Settings for helm uninstall.

Member	Signature	Doc
`release`	`release(name: string): this`	The release name to uninstall (required).
`keepHistory`	`keepHistory(): this`	Retain release history (`--keep-history`).
`wait`	`wait(): this`	Wait until removal completes (`--wait`).

# HelmUpgradeSettings class

class HelmUpgradeSettings extends HelmValuesSettings

Settings for helm upgrade.

Member	Signature	Doc
`release`	`release(name: string): this`	The release name (required).
`chart`	`chart(ref: string): this`	The chart reference or path (required).
`install`	`install(): this`	Install the release if it does not exist (`--install`).
`createNamespace`	`createNamespace(): this`	Create the release namespace if absent (`--create-namespace`).
`wait`	`wait(): this`	Wait until resources are ready (`--wait`).
`atomic`	`atomic(): this`	Roll back on failure (`--atomic`).
`timeout`	`timeout(duration: string): this`	Operation timeout, e.g. `5m` (`--timeout`).

# HelmValuesSettings class

class HelmValuesSettings extends HelmSettings

Base for value-bearing commands (install/upgrade/template).

Member	Signature	Doc
`values`	`values(path: PathLike): this`	Add a values file (`--values`/`-f`); repeatable.
`set`	`set(name: string, value: string): this`	Override a single value (`--set name=value`); repeatable.
`version`	`version(value: string): this`	Pin the chart version (`--version`).