CLI Reference

jhelm provides a command-line interface built on Picocli and Spring Boot.

java -jar jhelm-app/target/jhelm-{jhelm-version}.jar [command] [options]

1. Chart Lifecycle Commands

1.1. create

Create a new chart with the given name.

jhelm create <name> [-p <starter>]

Argument Required Description

Argument	Required	Description
`name`	Yes	Chart name
`-p, --starter`	No	Name or absolute path to a Helm starter scaffold

name

Yes

Chart name

-p, --starter

Name or absolute path to a Helm starter scaffold

1.2. template

Render chart templates locally (without deploying).

jhelm template <name> <chartPath> [-n <namespace>] [-f <values>] [--set <key=value>]

Argument Required Description

Argument	Required	Description
`name`	Yes	Release name
`chartPath`	Yes	Path to the chart directory or archive
`-n, --namespace`	No	Namespace (default: `default`)
`-f, --values`	No	Values YAML file(s), repeatable
`--set`	No	Set values on the command line (`key=value`, dot notation), repeatable

name

Yes

Release name

chartPath

Yes

Path to the chart directory or archive

-n, --namespace

Namespace (default: default)

-f, --values

Values YAML file(s), repeatable

--set

Set values on the command line (key=value, dot notation), repeatable

1.3. install

Install a chart to the cluster.

jhelm install <name> <chartPath> [-n <namespace>] [--dry-run] [-f <values>] [--set <key=value>] [--wait] [--timeout <seconds>]

Argument Required Description

Argument	Required	Description
`name`	Yes	Release name
`chartPath`	Yes	Chart path
`-n, --namespace`	No	Namespace (default: `default`)
`--dry-run`	No	Simulate the install without deploying
`-f, --values`	No	Values YAML file(s), repeatable
`--set`	No	Set values (`key=value`), repeatable
`--wait`	No	Wait until all resources are ready
`--timeout`	No	Timeout in seconds for `--wait` (default: `300`)

name

Yes

Release name

chartPath

Yes

Chart path

-n, --namespace

Namespace (default: default)

--dry-run

Simulate the install without deploying

-f, --values

Values YAML file(s), repeatable

--set

Set values (key=value), repeatable

--wait

Wait until all resources are ready

--timeout

Timeout in seconds for --wait (default: 300)

1.4. upgrade

Upgrade an existing release.

jhelm upgrade <name> <chartPath> [-n <namespace>] [--install] [--dry-run] [-f <values>] [--set <key=value>] [--wait] [--timeout <seconds>]

Argument Required Description

Argument	Required	Description
`name`	Yes	Release name
`chartPath`	Yes	Chart path
`-n, --namespace`	No	Namespace (default: `default`)
`--install`	No	Install if the release does not exist
`--dry-run`	No	Simulate the upgrade
`-f, --values`	No	Values YAML file(s), repeatable
`--set`	No	Set values (`key=value`), repeatable
`--wait`	No	Wait until all resources are ready
`--timeout`	No	Timeout in seconds for `--wait` (default: `300`)

name

Yes

Release name

chartPath

Yes

Chart path

-n, --namespace

Namespace (default: default)

--install

Install if the release does not exist

--dry-run

Simulate the upgrade

-f, --values

Values YAML file(s), repeatable

--set

Set values (key=value), repeatable

--wait

Wait until all resources are ready

--timeout

Timeout in seconds for --wait (default: 300)

1.5. uninstall

Uninstall a release from the cluster.

jhelm uninstall <name> [-n <namespace>]

Argument Required Description

Argument	Required	Description
`name`	Yes	Release name
`-n, --namespace`	No	Namespace (default: `default`)

name

Yes

Release name

-n, --namespace

Namespace (default: default)

1.6. rollback

Roll back a release to a previous revision.

jhelm rollback <name> <revision> [-n <namespace>]

Argument Required Description

Argument	Required	Description
`name`	Yes	Release name
`revision`	Yes	Revision number to roll back to
`-n, --namespace`	No	Namespace (default: `default`)

name

Yes

Release name

revision

Yes

Revision number to roll back to

-n, --namespace

Namespace (default: default)

2. Release Query Commands

2.1. list

List all releases in a namespace.

jhelm list [-n <namespace>]

Argument Required Description

Argument	Required	Description
`-n, --namespace`	No	Namespace (default: `default`)

-n, --namespace

Namespace (default: default)

2.2. status

Display the status of a release.

jhelm status <name> [-n <namespace>] [--show-resources]

Argument Required Description

Argument	Required	Description
`name`	Yes	Release name
`-n, --namespace`	No	Namespace (default: `default`)
`--show-resources`	No	Show resource readiness status

name

Yes

Release name

-n, --namespace

Namespace (default: default)

--show-resources

Show resource readiness status

2.3. history

Fetch release history.

jhelm history <name> [-n <namespace>]

Argument Required Description

Argument	Required	Description
`name`	Yes	Release name
`-n, --namespace`	No	Namespace (default: `default`)

name

Yes

Release name

-n, --namespace

Namespace (default: default)

2.4. get

Download extended information about a release. Has several subcommands.

2.4.1. get values

jhelm get values <releaseName> [-n <namespace>] [--revision <rev>] [-a] [-o <format>]

Argument Required Description

Argument	Required	Description
`releaseName`	Yes	Release name
`-n, --namespace`	No	Namespace (default: `default`)
`--revision`	No	Specific revision
`-a, --all`	No	Dump all (computed) values
`-o, --output`	No	Output format: `yaml` or `json` (default: `yaml`)

releaseName

Yes

Release name

-n, --namespace

Namespace (default: default)

--revision

Specific revision

-a, --all

Dump all (computed) values

-o, --output

Output format: yaml or json (default: yaml)

2.4.2. get manifest

jhelm get manifest <releaseName> [-n <namespace>] [--revision <rev>]

2.4.3. get notes

jhelm get notes <releaseName> [-n <namespace>] [--revision <rev>]

2.4.4. get hooks

jhelm get hooks <releaseName> [-n <namespace>] [--revision <rev>]

2.4.5. get metadata

jhelm get metadata <releaseName> [-n <namespace>] [--revision <rev>] [-o <format>]

2.4.6. get all

jhelm get all <releaseName> [-n <namespace>] [--revision <rev>]

3. Chart Inspection Commands

3.1. show

Show information about a chart.

3.1.1. show chart

Show the chart’s Chart.yaml.

jhelm show chart <chartPath>

3.1.2. show values

Show the chart’s values.yaml.

jhelm show values <chartPath>

3.1.3. show readme

Show the chart’s README.

jhelm show readme <chartPath>

3.1.4. show crds

Show the chart’s Custom Resource Definitions.

jhelm show crds <chartPath>

3.1.5. show all

Show all information about the chart.

jhelm show all <chartPath>

4. Repository Commands

4.1. repo add

Add a chart repository.

jhelm repo add <name> <url>

4.2. repo list

List configured chart repositories.

jhelm repo list

4.3. repo remove

Remove a chart repository.

jhelm repo remove <name>

4.4. repo search

Search repositories for a chart.

jhelm repo search <query> [--versions]

Argument Required Description

Argument	Required	Description
`query`	Yes	Chart query in the form `repo/chart`
`--versions`	No	Show all available versions

query

Yes

Chart query in the form repo/chart

--versions

Show all available versions

5. Registry Commands

5.1. registry login

Authenticate with an OCI registry.

jhelm registry login <server> -u <username> -p <password>

5.2. registry logout

Log out from an OCI registry.

jhelm registry logout <server>

6. Distribution Commands

6.1. pull

Download a chart from a repository.

jhelm pull <chart> [--version <version>] [-d <dest>]

Argument Required Description

Argument	Required	Description
`chart`	Yes	Chart reference: `repo/chart`, `repo/chart:version`, or `oci://…`
`--version`	No	Chart version (required for repo charts)
`-d, --dest`	No	Destination directory (default: `.`)

chart

Yes

Chart reference: repo/chart, repo/chart:version, or oci://…

--version

Chart version (required for repo charts)

-d, --dest

Destination directory (default: .)

6.2. push

Push a chart archive to an OCI registry.

jhelm push <chart> <remote>

Argument Required Description

Argument	Required	Description
`chart`	Yes	Path to the chart archive (`.tgz`)
`remote`	Yes	OCI registry destination (`oci://registry/repo/chart[:tag]`)

chart

Yes

Path to the chart archive (.tgz)

remote

Yes

OCI registry destination (oci://registry/repo/chart[:tag])

7. Dependency Commands

7.1. dependency list

List chart dependencies.

jhelm dependency list [chartPath]

Argument Required Description

Argument	Required	Description
`chartPath`	No	Chart directory (default: `.`)

chartPath

Chart directory (default: .)

7.2. dependency update

Update the charts/ directory based on Chart.yaml dependencies.

jhelm dependency update [chartPath] [--skip-refresh] [--with-tags <tags>]

Argument Required Description

Argument	Required	Description
`chartPath`	No	Chart directory (default: `.`)
`--skip-refresh`	No	Skip refreshing the local repository cache
`--with-tags`	No	Dependency tags to include (comma-separated), repeatable

chartPath

Chart directory (default: .)

--skip-refresh

Skip refreshing the local repository cache

--with-tags

Dependency tags to include (comma-separated), repeatable

7.3. dependency build

Rebuild the charts/ directory based on Chart.lock.

jhelm dependency build [chartPath] [--skip-refresh]

Argument Required Description

Argument	Required	Description
`chartPath`	No	Chart directory (default: `.`)
`--skip-refresh`	No	Skip refreshing the local repository cache

chartPath

Chart directory (default: .)

--skip-refresh

Skip refreshing the local repository cache