Gardenctl Rc Zsh

gardenctl rc zsh

Generate a gardenctl startup script for zsh

Synopsis

Generate a gardenctl startup script for zsh that contains various tweaks, such as setting environment variables, loading completions and adding some helpful aliases or functions.

If shell completion is not already enabled in your environment you need to add at least this command to your zsh configuration file:

autoload -Uz compinit && compinit

To load gardenctl startup script for each zsh session add the following line at the end of the ~/.zshrc file:

source <(gardenctl rc zsh)

You will need to start a new shell for this setup to take effect.

Zshell frameworks or plugin manager

If you use a framework for managing your zsh configuration you may need to load this code as a custom plugin in your framework.

oh-my-zsh:

Create a file ~/.oh-my-zsh/custom/plugins/gardenctl/gardenctl.plugin.zsh with the following content:

if (( $+commands[gardenctl] )); then
  source <(gardenctl rc zsh)
fi

To use it, add gardenctl to the plugins array in your ~/.zshrc file:

plugins=(... gardenctl)

For more information about oh-my-zsh custom plugins please refer to https://github.com/ohmyzsh/ohmyzsh#custom-plugins-and-themes.

zgen:

Create an oh-my-zsh plugin for gardenctl like described above and load it in the .zshrc file:

zgen load /path/to/custom/plugins/gardenctl

For more information about loading plugins with zgen please refer to https://github.com/tarjoilija/zgen#load-plugins-and-completions

zinit:

Create an oh-my-zsh plugin for gardenctl like described above and load it in the .zshrc file:

zinit snippet /path/to/custom/plugins/gardenctl/gardenctl.plugin.zsh

For more information about loading plugins and snippets with zinit please refer to https://github.com/zdharma-continuum/zinit#plugins-and-snippets.

gardenctl rc zsh [flags]

Options

  -h, --help            help for zsh
      --no-completion   The startup script should not setup completion
      --no-kubeconfig   The startup script should not modify the KUBECONFIG environment variable
  -p, --prefix string   The prefix used for aliases and functions (default "g")

Options inherited from parent commands

      --add-dir-header                   If true, adds the file directory to the header of the log messages
      --alsologtostderr                  log to standard error as well as files (no effect when -logtostderr=true)
      --config string                    config file (default is ~/.garden/gardenctl-v2.yaml)
      --log-backtrace-at traceLocation   when logging hits line file:N, emit a stack trace (default :0)
      --log-dir string                   If non-empty, write log files in this directory (no effect when -logtostderr=true)
      --log-file string                  If non-empty, use this log file (no effect when -logtostderr=true)
      --log-file-max-size uint           Defines the maximum size a log file can grow to (no effect when -logtostderr=true). Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800)
      --logtostderr                      log to standard error instead of files (default true)
      --one-output                       If true, only write logs to their native severity level (vs also writing to each lower severity level; no effect when -logtostderr=true)
      --skip-headers                     If true, avoid header prefixes in the log messages
      --skip-log-headers                 If true, avoid headers when opening log files (no effect when -logtostderr=true)
      --stderrthreshold severity         logs at or above this threshold go to stderr when writing to files and stderr (no effect when -logtostderr=true or -alsologtostderr=true) (default 2)
  -v, --v Level                          number for the log level verbosity
      --vmodule moduleSpec               comma-separated list of pattern=N settings for file-filtered logging

SEE ALSO

• gardenctl rc - Generate a gardenctl startup script for the specified shell