Skip to main content
Version: 0.0.5

CLI Reference

wego#

wego is the command-line interface for installing and controlling the Weave GitOps infrastructure

Weave GitOps
Usage:  wego [command]
Available Commands:  app         Use app commands  flux        Use flux commands  help        Help about any command  install     Install or upgrade Wego  version     Display wego version
Flags:  -h, --help               help for wego      --namespace string   gitops runtime namespace (default "wego-system")  -v, --verbose            Enable verbose output
Use "wego [command] --help" for more information about a command.

wego install#

wego install will install Weave GitOps into the current Kubernetes cluster. By default it will use the wego-system namespace, but you can change this.

The install command deploys Wego in the specified namespace.If a previous version is installed, then an in-place upgrade will be performed.
Usage:  wego install [flags]
Examples:  # Install wego in the wego-system namespace  wego install
Flags:  -h, --help   help for install
Global Flags:      --namespace string   gitops runtime namespace (default "wego-system")  -v, --verbose            Enable verbose output

wego app#

Weave GitOps enables continuous deployment of workloads to Kubernetes targets. An "app" is a workload that can be deployed.

Usage:  wego app [command]
Available Commands:  add         Add a workload repository to a wego cluster  status      Get status of an app
Flags:  -h, --help   help for app
Global Flags:      --namespace string   gitops runtime namespace (default "wego-system")  -v, --verbose            Enable verbose output
Use "wego app [command] --help" for more information about a command.

wego app add#

wego app add adds an application workload to the GitOps workflow. The simplest way to use this is to set the current directory to point to a repository that you want GitOps'ed into the cluster and use wego app add .

Associates an additional application in a git repository with a wego cluster so that its contents may be managed via GitOps
Usage:  wego app add [--name <name>] [--url <url>] [--branch <branch>] [--path <path within repository>] [--private-key <keyfile>] <repository directory> [flags]
Examples:wego add .
Flags:      --app-config-url string    URL of external repository (if any) which will hold automation manifests; NONE to store only in the cluster      --branch string            Branch to watch within git repository (default "main")      --deployment-type string   deployment type [kustomize, helm] (default "kustomize")      --dry-run                  If set, 'wego add' will not make any changes to the system; it will just display the actions that would have been taken  -h, --help                     help for add      --name string              Name of remote git repository      --owner string             Owner of remote git repository      --path string              Path of files within git repository (default "./")      --private-key string       Private key that provides access to git repository (default "/Users/paul/.ssh/id_rsa")      --url string               URL of remote git repository
Global Flags:      --namespace string   gitops runtime namespace (default "wego-system")  -v, --verbose            Enable verbose output

wego app status#

Get the status of a GitOps'ed app

Usage:  wego app status <app-name> [flags]
Examples:wego app status podinfo
Flags:  -h, --help   help for status
Global Flags:      --namespace string   gitops runtime namespace (default "wego-system")  -v, --verbose            Enable verbose output

wego flux#

This command enables access to and control of the underlying Flux runtime.

Please see flux documentation

wego version#

Display wego version
Usage:  wego version [flags]
Flags:  -h, --help   help for version
Global Flags:      --namespace string   gitops runtime namespace (default "wego-system")  -v, --verbose            Enable verbose output