CLIs in the wild

Note

This README is automatically generated from README.tpl.md based on analyzing the data from the YAML files on the root of this directory.

This document describe what approach was implemented by some popular CLI to display its version.

Analyzed 16 CLIs:

How to get the version

via command (only)

7 of 16

via flag (only)

1 of 16

CLI Name	Flags
rancher	`--version`, `-v`

via flag and command (both)

8 of 16

CLI Name	Flags	Command
docker	`--version`, `-v`	`version`
gh	`--version`	`version`
golangci-lint	`--version`	`version`
helm	`--version`, `-v`	`version`
k3d	`--version`	`version`
porter	`--version`, `-v`	`version`
terraform	`--version`, `-v`	`version`
vault	`--version`, `-v`	`version`

Overall flag names popularity

Name	Number of usage
`--version`	9
`-v`	6

Upgrade notice

fass-cli version --warn-update

Note It's enabled by default, doesn't have cache, and uses HEAD */releases/latest to check new release.
```
Your faas-cli version (%s) may be out of date. Version: %s is now available on GitHub.
```
gh

Note It's enabled by default, have cache, and uses GET */releases/latest. It checks for new releases once every 24 hours and displays an upgrade notice on stderr error if a newer version was found
```
A new release of gh is available: 2.5.1 → v2.5.2
To upgrade, run: brew update && brew upgrade gh
https://github.com/cli/cli/releases/tag/v2.5.2
```

terraform version

Note When the JSON format is used the terraform_outdated property is set to true. They call own service https://github.com/hashicorp/go-checkpoint.

Terraform v1.2.8
on darwin_amd64

Your version of Terraform is out of date! The latest version
is 1.2.9. You can update by downloading from https://www.terraform.io/downloads.html

What data is collected

Server

Name	Occurrences	Alternative name
`API version`	1
`Context`	1
`Experimental`	1
`buildDate`	2	`Built`
`commit`	3	`Git Commit`, `sha`, `gitCommit`
`compiler`	1
`dirty`	1	`gitTreeState`
`gitVersion`	1
`go`	2	`Go version`, `goVersion`
`major`	1
`minor`	1
`platform`	2	`OS/Arch`
`url`	1	`uri`
`version`	2	`Version`

Client

Name	Occurrences	Alternative name
`API version`	1
`Context`	1
`EKSServerSupportedVersions`	1
`Experimental`	1
`PreReleaseID`	1
`buildDate`	9	`BuildDate`, `Built`, `Metadata.BuildDate`, `date`, `Date`
`changelogURL`	1
`commit`	11	`GitCommit`, `Git Commit`, `Metadata.GitCommit`, `sha`, `gitCommit`
`compiler`	2	`Compiler`
`dirty`	3	`gitTreeState`, `GitTreeState`
`gitTag`	1
`gitVersion`	1
`go`	4	`goVersion`, `Go version`, `GoVersion`
`k3s image version`	1
`major`	1
`minor`	1
`platform`	4	`Platform`, `OS/Arch`
`version`	14	`Version`

Dependencies

Name	Occurrences	Alternative name
`Kustomize`	1
`Stack Services`	1
`containerd`	1
`docker-init`	1
`runc`	1
`system`	1

Output

JSON

eksctl version -ojson

{
  "Version": "0.108.0",
  "PreReleaseID": "",
  "Metadata": {
    "BuildDate": "2022-08-12T08:12:00Z",
    "GitCommit": "728d4ad"
  },
  "EKSServerSupportedVersions": [
    "1.19",
    "1.20",
    "1.21",
    "1.22"
  ]
}

golangci-lint version --format json

{"version":"1.48.0","commit":"2d8fea8","date":"2022-08-04T09:19:19Z"}

kubectl version -ojson

{
  "clientVersion": {
    "major": "1",
    "minor": "24",
    "gitVersion": "v1.24.0",
    "gitCommit": "4ce5a8954017644c5420bae81d72b09b735c21f0",
    "gitTreeState": "clean",
    "buildDate": "2022-05-03T13:46:05Z",
    "goVersion": "go1.18.1",
    "compiler": "gc",
    "platform": "darwin/amd64"
  },
  "kustomizeVersion": "v4.5.4",
  "serverVersion": {
    "major": "1",
    "minor": "23",
    "gitVersion": "v1.23.6+k3s1",
    "gitCommit": "418c3fa858b69b12b9cefbcff0526f666a6236b9",
    "gitTreeState": "clean",
    "buildDate": "2022-04-28T22:16:18Z",
    "goVersion": "go1.17.5",
    "compiler": "gc",
    "platform": "linux/amd64"
  }
}

minikube version --ojson

{"commit":"62e108c3dfdec8029a890ad6d8ef96b6461426dc","minikubeVersion":"v1.26.1"}

porter version -ojson

{
  "name": "porter",
  "version": "v1.0.0-beta.3",
  "commit": "f7aa99dc"
}

terraform version --json

{
  "terraform_version": "1.2.8",
  "platform": "darwin_amd64",
  "provider_selections": {},
  "terraform_outdated": false
}

YAML

kubectl version -oyaml

clientVersion:
  buildDate: "2022-05-03T13:46:05Z"
  compiler: gc
  gitCommit: 4ce5a8954017644c5420bae81d72b09b735c21f0
  gitTreeState: clean
  gitVersion: v1.24.0
  goVersion: go1.18.1
  major: "1"
  minor: "24"
  platform: darwin/amd64
kustomizeVersion: v4.5.4
serverVersion:
  buildDate: "2022-04-28T22:16:18Z"
  compiler: gc
  gitCommit: 418c3fa858b69b12b9cefbcff0526f666a6236b9
  gitTreeState: clean
  gitVersion: v1.23.6+k3s1
  goVersion: go1.17.5
  major: "1"
  minor: "23"
  platform: linux/amd64

minikube version --oyaml

commit: 62e108c3dfdec8029a890ad6d8ef96b6461426dc
minikubeVersion: v1.26.1

GoTemplate

docker version --format/-f
helm version --template

Plain

argo version

argo: v3.3.9+5db53aa.dirty
  BuildDate: 2022-08-10T02:08:30Z
  GitCommit: 5db53aa0ca54e51ca69053e1d3272e37064559d7
  GitTreeState: dirty
  GitTag: v3.3.9
  GoVersion: go1.19
  Compiler: gc
  Platform: darwin/amd64

docker version

Client:
  Version:           20.10.9
  API version:       1.41
  Go version:        go1.16.8
  Git commit:        c2ea9bc
  Built:             Thu Nov 18 21:15:43 2021
  OS/Arch:           darwin/amd64
  Context:           default
  Experimental:      true

Server: Docker Desktop 4.8.2 (79419)
  Engine:
    Version:          20.10.14
    API version:      1.41 (minimum version 1.12)
    Go version:       go1.16.15
    Git commit:       87a90dc
    Built:            Thu Mar 24 01:46:14 2022
    OS/Arch:          linux/amd64
    Experimental:     false
  containerd:
    Version:          1.5.11
    GitCommit:        3df54a852345ae127d1fa3092b95168e4a88e2f8
  runc:
    Version:          1.0.3
    GitCommit:        v1.0.3-0-gf46b6ba
  docker-init:
    Version:          0.19.0
    GitCommit:        de40ad0

gh version

gh version 2.14.4 (2022-08-10)
https://github.com/cli/cli/releases/tag/v2.14.4

golangci-lint version

golangci-lint has version 1.48.0 built from 2d8fea8 on 2022-08-04T09:19:19Z

helm version

version.BuildInfo{Version:"v3.9.3", GitCommit:"414ff28d4029ae8c8b05d62aa06c7fe3dee2bc58", GitTreeState:"clean", GoVersion:"go1.19"}

k3d version

k3d version v5.4.4
k3s version v1.23.8-k3s1 (default)

version colored output

____  __.________
|    |/ _/   __   \______
|      < \____    /  ___/
|    |  \   /    /\___ \
|____|__ \ /____//____  >
\/            \/

Version: 0.26.5
Commit: c35949189f8bbf9fdca109970b23444b4165e341
Date: n/a

minikube version

minikube version: v1.26.1
commit: 62e108c3dfdec8029a890ad6d8ef96b6461426dc

version nicely colored output

 ___     ___ _____   _____                       K          .-'-.
| _ \___| _ \ __\ \ / / __|                       8     __|      `\
|  _/ _ \  _/ _| \ V /| _|                         s   `-,-`--._   `\
|_| \___/_| |___| |_| |___|                       []  .->'  a     `|-'
  Biffs`em and Buffs`em!                            `=/ (__/_       /
                                                      \_,    `    _)
                                                         `----;  |
Version:   0.10.1
Commit:    ae19897a4b5d3738a3e98179207759e45a53a64c
Date:      2022-06-28T14:46:13Z
Logs:      /var/folders/fs/434y31hj5wl278vrt_4gllt40000gn/T/popeye.log

porter version
```
porter v1.0.0-beta.3 (f7aa99dc)
```
rancher --version
```
rancher version v2.6.7
```
terraform version
```
Terraform v1.2.8
on darwin_amd64
```

vault version

Vault v1.11.2 (3a8aa12eba357ed2de3192b15c99c717afdeb2b5), built 2022-07-29T09:48:47Z

Short

argo version --short
```
argo: v3.3.9+5db53aa.dirty
```
docker --version/-v
```
Docker version 20.10.9, build c2ea9bc
```
eksctl version
```
0.108.0
```
fass-cli version --short-version
```
0.14.5
```
golangci-lint version --format short
```
1.48.0
```
helm version --short

version -s

Version              0.26.5
Commit               c35949189f8bbf9fdca109970b23444b4165e341
Date                 n/a

kubectl version --short (deprecated, will be default in the future)
```
Client Version: v1.24.0
Kustomize Version: v4.5.4
```
minikube version --short

System

minikube version --components -oyaml

buildctl: buildctl github.com/moby/buildkit v0.10.3 c8d25d9a103b70dc300a4fd55e7e576472284e31
commit: 62e108c3dfdec8029a890ad6d8ef96b6461426dc
containerd: containerd containerd.io 1.6.6 10c12954828e7c7c9b6e0ea9b0c02b01407d3ae1
cri-dockerd: ""
crictl: crictl version v1.21.0
crio: crio version 1.24.1
crun: crun version UNKNOWN
ctr: ctr containerd.io 1.6.6
docker: Docker version 20.10.17, build 100c701
dockerd: Docker version 20.10.17, build a89b842
minikubeVersion: v1.26.1
podman: podman version 3.4.2
runc: runc version 1.1.2

porter version --system Print system debug information

Frameworks

Popularity

Name	Occurrences
`github.com/mitchellh/cli`	2
`github.com/spf13/cobra`	13
`github.com/urfave/cli`	1

Built-in support

Cobra

cmd := &cobra.Command{
	Use:   "example",
	Short: "An example CLI built with github.com/spf13/cobra",

	// Version defines the version for this command. If this value is non-empty and the command does not
	// define a "version" flag, a "version" boolean flag will be added to the command and, if specified,
	// will print content of the "Version" variable. A shorthand "v" flag will also be added if the
	// command does not define one.
	Version: "1.0.3",
}

Others

Interesting approach to print the version of deps: https://github.com/hashicorp/terraform/blob/v1.3.0-dev/version/dependencies.go

Name		Name	Last commit message	Last commit date
Latest commit History 15 Commits
magefiles		magefiles
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
README.tpl.md		README.tpl.md
argo.yaml		argo.yaml
docker.yaml		docker.yaml
eksctl.yaml		eksctl.yaml
fass-cli.yaml		fass-cli.yaml
gh.yaml		gh.yaml
golangci-lint.yaml		golangci-lint.yaml
helm.yaml		helm.yaml
k3d.yaml		k3d.yaml
k9s.yaml		k9s.yaml
kubectl.yaml		kubectl.yaml
minikube.yaml		minikube.yaml
popeye.yaml		popeye.yaml
porter.yaml		porter.yaml
rancher.yaml		rancher.yaml
terraform.yaml		terraform.yaml
vault.yaml		vault.yaml

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

CLIs in the wild

How to get the version

via command (only)

via flag (only)

via flag and command (both)

Overall flag names popularity

Upgrade notice

What data is collected

Server

Client

Dependencies

Output

JSON

YAML

GoTemplate

Plain

Short

System

Frameworks

Popularity

Built-in support

Cobra

Others

About

Languages

License

mszostok/cli-analysis

Folders and files

Latest commit

History

Repository files navigation

CLIs in the wild

How to get the version

via command (only)

via flag (only)

via flag and command (both)

Overall flag names popularity

Upgrade notice

What data is collected

Server

Client

Dependencies

Output

JSON

YAML

GoTemplate

Plain

Short

System

Frameworks

Popularity

Built-in support

Cobra

Others

About

Topics

Resources

License

Stars

Watchers

Forks

Languages