CLI Reference

Auto-generated from the helm-me CLI definition.

helm-me COMMAND

Define, deploy, and operate Kubernetes applications.

Use helm-me <group> --help to see subgroup commands.

Table of Contents

• --install-completion
• lint
• render
• deploy
• diff
• update
• app
  • list
  • use
  • current
  • import
  • generate-spec
  • delete
• ops
  • pods
  • status
  • logs
  • stats
  • events
  • describe
  • shell
  • exec
  • port-forward
  • scale
  • restart
  • pause
  • cp
• secret
  • set
  • get
• volume
  • upload
• image
  • load
• chart
  • export
• job
  • run

Commands:

• app: Manage saved app registrations and imported apps.
• chart: Export snapshot Helm charts.
• deploy: Deploy the app to Kubernetes (create-or-update all resources).
• diff: Show what would change if the spec were deployed now (kubectl diff).
• image: Manage local images for dev clusters.
• job: Manage and trigger Jobs.
• lint: Validate the app spec and report any problems.
• ops: Operate on deployed applications.
• render: Print the rendered Kubernetes manifests to stdout.
• secret: Manage Kubernetes Secrets.
• update: Re-deploy an app using its last registered spec file.
• volume: Manage persistent volume data.
• --install-completion: Install shell completion for this application.

Parameters:

• --verbose, --no-verbose: [default: False]
• --debug, --no-debug: [default: False]

helm-me --install-completion

helm-me --install-completion [OPTIONS]

Install shell completion for this application.

This command generates and installs the completion script to the appropriate location for your shell. After installation, you may need to restart your shell or source your shell configuration file.

Parameters:

• --verbose, --no-verbose: [default: False]
• --debug, --no-debug: [default: False]
• --shell: Shell type for completion. If not specified, attempts to auto-detect current shell. [choices: zsh, bash, fish]
• --output, -o: Output path for the completion script. If not specified, uses shell-specific default.

helm-me lint

helm-me lint SPEC

Validate the app spec and report any problems.

Parameters:

• --verbose, --no-verbose: [default: False]
• --debug, --no-debug: [default: False]
• SPEC, --spec: [required]

helm-me render

helm-me render SPEC [ARGS]

Print the rendered Kubernetes manifests to stdout.

Parameters:

• --verbose, --no-verbose: [default: False]
• --debug, --no-debug: [default: False]
• SPEC, --spec: [required]
• FORCE-PULL, --force-pull, --no-force-pull: [default: False]

helm-me deploy

helm-me deploy SPEC [ARGS]

Deploy the app to Kubernetes (create-or-update all resources).

Parameters:

• --verbose, --no-verbose: [default: False]
• --debug, --no-debug: [default: False]
• SPEC, --spec: [required]
• KUBECONFIG, --kubeconfig:
• CONTEXT, --context:
• NAMESPACE, --namespace:
• YES, --yes, --no-yes: [default: False]
• FORCE-PULL, --force-pull, --no-force-pull: [default: False]
• RESTART, --restart, --no-restart: [default: False]
• WAIT, --wait, --no-wait: [default: True]
• WAIT-TIMEOUT, --wait-timeout: [default: 300]

helm-me diff

helm-me diff SPEC [ARGS]

Show what would change if the spec were deployed now (kubectl diff).

Parameters:

• --verbose, --no-verbose: [default: False]
• --debug, --no-debug: [default: False]
• SPEC, --spec: [required]
• KUBECONFIG, --kubeconfig:
• CONTEXT, --context:
• NAMESPACE, --namespace:

helm-me update

helm-me update [ARGS]

Re-deploy an app using its last registered spec file.

Parameters:

• --verbose, --no-verbose: [default: False]
• --debug, --no-debug: [default: False]
• APP-NAME, --app-name:
• KUBECONFIG, --kubeconfig:
• CONTEXT, --context:
• NAMESPACE, --namespace:
• YES, --yes, --no-yes: [default: False]
• FORCE-PULL, --force-pull, --no-force-pull: [default: False]
• RESTART, --restart, --no-restart: [default: False]
• WAIT, --wait, --no-wait: [default: True]
• WAIT-TIMEOUT, --wait-timeout: [default: 300]

helm-me app

Manage saved app registrations and imported apps.

Parameters:

• --verbose, --no-verbose: [default: False]
• --debug, --no-debug: [default: False]

helm-me app list

helm-me app list

List registered applications.

helm-me app use

helm-me app use [ARGS]

Set the active application.

Parameters:

• APP-NAME, --app-name:

helm-me app current

helm-me app current

Show the active application.

helm-me app import

helm-me app import APP-NAME [ARGS]

Register an existing Kubernetes deployment for helm-me operations.

Parameters:

• APP-NAME, --app-name: [required]
• NAMESPACE, --namespace:
• KUBECONFIG, --kubeconfig:
• CONTEXT, --context:
• LABEL, --label:

helm-me app generate-spec

helm-me app generate-spec [ARGS]

Generate a deploy spec from a live deployment.

Parameters:

• APP-NAME, --app-name:
• FMT, --fmt: [default: yaml]
• OUTPUT, --output:
• KUBECONFIG, --kubeconfig:
• CONTEXT, --context:
• NAMESPACE, --namespace:

helm-me app delete

helm-me app delete [ARGS]

Delete a managed app from the cluster and remove it from the registry.

Parameters:

• APP-NAME, --app-name:
• KUBECONFIG, --kubeconfig:
• CONTEXT, --context:
• NAMESPACE, --namespace:
• YES, --yes, --no-yes: [default: False]

helm-me ops

Operate on deployed applications.

Parameters:

• --verbose, --no-verbose: [default: False]
• --debug, --no-debug: [default: False]

helm-me ops pods

helm-me ops pods [ARGS]

List pods for a deployed app.

Parameters:

• APP-NAME, --app-name:
• KUBECONFIG, --kubeconfig:
• CONTEXT, --context:
• NAMESPACE, --namespace:

helm-me ops status

helm-me ops status [ARGS]

Show pods, services, and ingresses.

Parameters:

• APP-NAME, --app-name:
• KUBECONFIG, --kubeconfig:
• CONTEXT, --context:
• NAMESPACE, --namespace:

helm-me ops logs

helm-me ops logs COMPONENT [ARGS]

Stream logs from a component.

Parameters:

• COMPONENT, --component: [required]
• APP-NAME, --app-name:
• KUBECONFIG, --kubeconfig:
• CONTEXT, --context:
• NAMESPACE, --namespace:
• --follow, --no-follow, -f: [default: False]
• --tail, -t: [default: 100]
• --container, -c:
• --previous, --no-previous, -p: [default: False]

helm-me ops stats

helm-me ops stats [ARGS]

Show live CPU and memory usage.

Parameters:

• APP-NAME, --app-name:
• KUBECONFIG, --kubeconfig:
• CONTEXT, --context:
• NAMESPACE, --namespace:

helm-me ops events

helm-me ops events [ARGS]

Show recent Kubernetes events for an app.

Parameters:

• APP-NAME, --app-name:
• KUBECONFIG, --kubeconfig:
• CONTEXT, --context:
• NAMESPACE, --namespace:
• --limit, -n: [default: 50]

helm-me ops describe

helm-me ops describe COMPONENT [ARGS]

Show detailed description of a component Deployment (kubectl describe).

Parameters:

• COMPONENT, --component: [required]
• APP-NAME, --app-name:
• KUBECONFIG, --kubeconfig:
• CONTEXT, --context:
• NAMESPACE, --namespace:

helm-me ops shell

helm-me ops shell COMPONENT [ARGS]

Open an interactive shell REPL in a component.

Parameters:

• COMPONENT, --component: [required]
• APP-NAME, --app-name:
• KUBECONFIG, --kubeconfig:
• CONTEXT, --context:
• NAMESPACE, --namespace:
• CONTAINER, --container:

helm-me ops exec

helm-me ops exec COMPONENT [ARGS]

Run a command or shell inside a component pod.

Parameters:

• COMPONENT, --component: [required]
• APP-NAME, --app-name:
• KUBECONFIG, --kubeconfig:
• CONTEXT, --context:
• NAMESPACE, --namespace:
• CONTAINER, --container:
• CMD, --cmd, --empty-cmd: [default: []]

helm-me ops port-forward

helm-me ops port-forward COMPONENT PORT [ARGS]

Forward a local port to a component service.

Parameters:

• COMPONENT, --component: [required]
• PORT, --port: [required]
• APP-NAME, --app-name:
• KUBECONFIG, --kubeconfig:
• CONTEXT, --context:
• NAMESPACE, --namespace:

helm-me ops scale

helm-me ops scale COMPONENT REPLICAS [ARGS]

Scale a component Deployment.

Parameters:

• COMPONENT, --component: [required]
• REPLICAS, --replicas: [required]
• APP-NAME, --app-name:
• KUBECONFIG, --kubeconfig:
• CONTEXT, --context:
• NAMESPACE, --namespace:
• YES, --yes, --no-yes: [default: False]

helm-me ops restart

helm-me ops restart [ARGS]

Rolling-restart app Deployments.

Parameters:

• APP-NAME, --app-name:
• KUBECONFIG, --kubeconfig:
• CONTEXT, --context:
• NAMESPACE, --namespace:
• YES, --yes, --no-yes: [default: False]

helm-me ops pause

helm-me ops pause [ARGS]

Scale Deployments to zero replicas.

Parameters:

• APP-NAME, --app-name:
• KUBECONFIG, --kubeconfig:
• CONTEXT, --context:
• NAMESPACE, --namespace:
• YES, --yes, --no-yes: [default: False]

helm-me ops cp

helm-me ops cp [ARGS]

Copy files between local disk and a component pod.

Parameters:

• SOURCE, --source:
• DEST, --dest:
• APP-NAME, --app-name:
• KUBECONFIG, --kubeconfig:
• CONTEXT, --context:
• NAMESPACE, --namespace:
• CONTAINER, --container:

helm-me secret

Manage Kubernetes Secrets.

Parameters:

• --verbose, --no-verbose: [default: False]
• --debug, --no-debug: [default: False]

helm-me secret set

helm-me secret set [OPTIONS] NAME [ARGS]

Create or update a Secret.

Parameters:

• NAME, --name: [required]
• APP-NAME, --app-name:
• KUBECONFIG, --kubeconfig:
• CONTEXT, --context:
• NAMESPACE, --namespace:
• REPLACE, --replace, --no-replace: [default: False]
• YES, --yes, --no-yes: [default: False]
• --set, --empty-set: [default: []]

helm-me secret get

helm-me secret get NAME [ARGS]

Inspect a Secret.

Parameters:

• NAME, --name: [required]
• APP-NAME, --app-name:
• KUBECONFIG, --kubeconfig:
• CONTEXT, --context:
• NAMESPACE, --namespace:
• REVEAL, --reveal, --no-reveal: [default: False]

helm-me volume

Manage persistent volume data.

Parameters:

• --verbose, --no-verbose: [default: False]
• --debug, --no-debug: [default: False]

helm-me volume upload

helm-me volume upload COMPONENT SOURCE [ARGS]

Upload data into a component volume.

Parameters:

• COMPONENT, --component: [required]
• SOURCE, --source: [required]
• APP-NAME, --app-name:
• KUBECONFIG, --kubeconfig:
• CONTEXT, --context:
• NAMESPACE, --namespace:
• RESTART, --restart, --no-restart: [default: False]
• YES, --yes, --no-yes: [default: False]

helm-me image

Manage local images for dev clusters.

Parameters:

• --verbose, --no-verbose: [default: False]
• --debug, --no-debug: [default: False]

helm-me image load

helm-me image load IMAGE-NAME [ARGS]

Load a local image into a dev cluster.

Parameters:

• IMAGE-NAME, --image-name: [required]
• KUBECONFIG, --kubeconfig:
• CONTEXT, --context:

helm-me chart

Export snapshot Helm charts.

Parameters:

• --verbose, --no-verbose: [default: False]
• --debug, --no-debug: [default: False]

helm-me chart export

helm-me chart export SPEC OUTPUT-DIR [ARGS]

Export a snapshot Helm chart.

Parameters:

• SPEC, --spec: [required]
• OUTPUT-DIR, --output-dir: [required]
• OVERWRITE, --overwrite, --no-overwrite: [default: False]

helm-me job

Manage and trigger Jobs.

Parameters:

• --verbose, --no-verbose: [default: False]
• --debug, --no-debug: [default: False]

helm-me job run

helm-me job run [OPTIONS] [ARGS]

Trigger a standalone Job component.

Parameters:

• NAME, --name: Name of the job component to run (from your deploy.yaml/py).
• --app-id: App name to look up. If not provided, uses the active default.
• --wait, --no-wait: If True, wait synchronously for the Job to finish. [default: False]
• --timeout: Timeout in seconds for waiting (only used if --wait is passed). [default: 300]