Skip to content

🛠 CLI Reference

NAME:
   helmwave - is like docker-compose for helm

USAGE:
   helmwave [global options] command [command options] [arguments...]

VERSION:
   0.16.2

DESCRIPTION:
   This tool helps you compose your helm releases!
   0. $ helmwave yml
   1. $ helmwave build
   2. $ helmwave up

COMMANDS:
   build         🏗 Build a plan
   diff, vs      🆚 Show Differences
   up            🚢 Apply your plan
   list, ls      👀 List of deployed releases
   rollback      ⏮  Rollback your plan
   status        👁️ Status of deployed releases
   down          🔪 Delete all
   validate      🛂 Validate your plan
   yml           📄 Render helmwave.yml.tpl -> helmwave.yml
   version, ver  Show shorts version
   completion    Generate completion script
   help, h       Shows a list of commands or help for one command


GLOBAL OPTIONS:
   --log-format value         You can set: [ text | json | pad | emoji ] (default: "emoji") [$HELMWAVE_LOG_FORMAT]
   --log-level value          You can set: [ debug | info | warn  | fatal | panic | trace ] (default: "info") [$HELMWAVE_LOG_LEVEL, $HELMWAVE_LOG_LVL]
   --log-color                Force color (default: true) [$HELMWAVE_LOG_COLOR]
   --kubedog-log-width value  Set kubedog max log line width (default: 140) [$HELMWAVE_KUBEDOG_LOG_WIDTH]
   --help, -h                 show help (default: false)
   --version, -v              print the version (default: false)

step #0: yml

It allows render helmwave.yml.tpl to helmwave.yml

Options

--tpl value             Main tpl file (default: "helmwave.yml.tpl") [$HELMWAVE_TPL]
--file value, -f value  Main yml file (default: "helmwave.yml") [$HELMWAVE_YAML]

step #1: build

This command generates .helmwave/

--plandir value         Path to plandir (default: ".helmwave/") [$HELMWAVE_PLANDIR]
--tags value, -t value  It allows you choose releases for sync. Example: -t tag1 -t tag3,tag4 [$HELMWAVE_TAGS]
--match-all-tags        Match all provided tags (default: false) [$HELMWAVE_MATCH_ALL_TAGS]
--file value, -f value  Main yml file (default: "helmwave.yml") [$HELMWAVE_YAML]
--diff-mode value       You can set: [ live | local ] (default: "live") [$HELMWAVE_DIFF_MODE]
--wide value            Show line around change (default: 5) [$HELMWAVE_DIFF_WIDE]
--show-secret           Show secret in diff (default: true) [$HELMWAVE_DIFF_SHOW_SECRET]

step #2: Working with plan

up

Helmwave will install repositories and helm-releases from plan.

down

Helmwave will uninstall helm-releases from plan.

$ helmwave down      
[🙃 aka INFO]: ✅ frontend@test uninstalled!
[🙃 aka INFO]: ✅ database@test uninstalled!
[🙃 aka INFO]: ✅ backend@test uninstalled!

ls

Helmwave try getting list of helm-releases from plan.

$ helmwave ls      
[🙃 aka INFO]: Should be 3 releases
   NAME    | NAMESPACE | REVISION |            UPDATED             |  STATUS  | CHART | VERSION  
-----------+-----------+----------+--------------------------------+----------+-------+----------
  frontend | test      |        1 | 2021-11-10 04:41:23.330989     | deployed | this  | 0.1.0    
           |           |          | +0300 MSK                      |          |       |          
  database | test      |        1 | 2021-11-10 04:41:23.353473     | deployed | this  | 0.1.0    
           |           |          | +0300 MSK                      |          |       |          
  backend  | test      |        1 | 2021-11-10 04:41:23.270076     | deployed | this  | 0.1.0    
           |           |          | +0300 MSK                      |          |       |

status

Helmwave try getting status of helm-releases from plan.

$ helmwave status      
[🙃 aka INFO]: Status of frontend@test
        status: deployed
        revision: 1
        name: frontend
        namespace: test
        chart: frontend-0.1.0
        last deployed: 2021-11-10 04:41:23.330989 +0300 MSK
[🙃 aka INFO]: Status of database@test
        status: deployed
        revision: 1
        name: database
        namespace: test
        chart: database-0.1.0
        last deployed: 2021-11-10 04:41:23.353473 +0300 MSK
[🙃 aka INFO]: Status of backend@test
        name: backend
        namespace: test
        chart: backend-0.1.0
        last deployed: 2021-11-10 04:41:23.270076 +0300 MSK
        status: deployed
        revision: 1

rollback

Helmwave will rollback helm-releases from plan.

$ helmwave down      
[🙃 aka INFO]: ✅ frontend@test rollback!
[🙃 aka INFO]: ✅ database@test rollback!
[🙃 aka INFO]: ✅ backend@test rollback!

validate

Helmwave will validate plan.

diff

Diff has 2 subcommands

  1. helmwave diff live will diff with manifests in the k8s-cluster
  2. helmwave diff plan will diff with your another local plan.

Logs

Logs options. Helmwave use logrus as internal logger.

Log Format

Helmwave supports several log-format

features text json pad emoji (default)
Color 🌈
Human readable 🧐 🤖 🧐🧐
Performance 🚀 🐢 ✈️ 🐢
Module TextFormatter (in-built logrus formatter) JSONFormatter (in-built logrus formatter) TextFormatter (in-built logrus formatter) logrus-emoji-formatter special for helmwave

Log Level

_ info (default) warn debug fatal panic trace
general info
incompatible version
helm-debug
file content
helm manifests, bug report

info or debug is preferred.

How to use?

helmwave <cmd> --log-color=true --log-level=debug --log-format=pad

or

export HELMWAVE_LOG_FORMAT=pad
export HELMWAVE_LOG_LEVEL=debug
export HELMWAVE_LOG_COLOR=true
helmwave <cmd>

Get Version

Long version

$ helmwave --version  
helmwave version 0.16.2

$ helmwave -v
helmwave version 0.16.2

Short version

$ helmwave version
0.16.2

$ helmwave ver
0.16.2

Completion

Bash

Add this code to your ~/.bashrc

source <(helmwave completion bash)
echo "source <(helmwave completion bash)" >> ~/.bashrc

completion-bash

ZSH

Add this code to your ~/.zshrc

source <(helmwave completion zsh)
echo "source <(helmwave completion zsh)" >> ~/.zshrc

completion-zsh

Back to top