No description
  • Go 99.5%
  • Makefile 0.5%
Find a file
oss-core-libraries-dashboard[bot] 4383e52914
[COMPLIANCE] Update Copyright and License Headers (#13)
Co-authored-by: hashicorp-copywrite[bot] <110428419+hashicorp-copywrite[bot]@users.noreply.github.com>
2025-11-02 18:10:26 +05:30
.github [COMPLIANCE] Update Copyright and License Headers (#13) 2025-11-02 18:10:26 +05:30
.go-version IND-2779 linting, .go-version fie added (#9) 2025-04-10 14:56:48 +05:30
autocomplete.go [COMPLIANCE] Update Copyright and License Headers (#13) 2025-11-02 18:10:26 +05:30
CHANGELOG.md chore: add CHANGELOG.md to track project changes (#10) 2025-05-29 21:31:29 +05:30
cli.go [COMPLIANCE] Update Copyright and License Headers (#13) 2025-11-02 18:10:26 +05:30
cli_test.go [COMPLIANCE] Update Copyright and License Headers (#13) 2025-11-02 18:10:26 +05:30
command.go [COMPLIANCE] Update Copyright and License Headers (#13) 2025-11-02 18:10:26 +05:30
command_mock.go [COMPLIANCE] Update Copyright and License Headers (#13) 2025-11-02 18:10:26 +05:30
command_mock_test.go [COMPLIANCE] Update Copyright and License Headers (#13) 2025-11-02 18:10:26 +05:30
go.mod Coverage test (#7) 2025-03-17 18:15:44 +05:30
go.sum IND-1807 Vulnerability fix (#6) 2025-01-29 15:11:21 +05:30
help.go [COMPLIANCE] Update Copyright and License Headers (#13) 2025-11-02 18:10:26 +05:30
LICENSE [COMPLIANCE] Update Copyright and License Headers (#13) 2025-11-02 18:10:26 +05:30
Makefile Update go versions used in CI 2020-03-23 12:19:25 -04:00
README.md s/mitchellh/hashicorp/g 2023-11-20 13:03:34 -08:00
ui.go [COMPLIANCE] Update Copyright and License Headers (#13) 2025-11-02 18:10:26 +05:30
ui_colored.go [COMPLIANCE] Update Copyright and License Headers (#13) 2025-11-02 18:10:26 +05:30
ui_common.go [COMPLIANCE] Update Copyright and License Headers (#13) 2025-11-02 18:10:26 +05:30
ui_concurrent.go [COMPLIANCE] Update Copyright and License Headers (#13) 2025-11-02 18:10:26 +05:30
ui_concurrent_test.go [COMPLIANCE] Update Copyright and License Headers (#13) 2025-11-02 18:10:26 +05:30
ui_js.go [COMPLIANCE] Update Copyright and License Headers (#13) 2025-11-02 18:10:26 +05:30
ui_mock.go [COMPLIANCE] Update Copyright and License Headers (#13) 2025-11-02 18:10:26 +05:30
ui_mock_test.go [COMPLIANCE] Update Copyright and License Headers (#13) 2025-11-02 18:10:26 +05:30
ui_test.go [COMPLIANCE] Update Copyright and License Headers (#13) 2025-11-02 18:10:26 +05:30
ui_writer.go [COMPLIANCE] Update Copyright and License Headers (#13) 2025-11-02 18:10:26 +05:30
ui_writer_test.go [COMPLIANCE] Update Copyright and License Headers (#13) 2025-11-02 18:10:26 +05:30

Go CLI Library GoDoc

cli is a library for implementing command-line interfaces in Go. cli is the library that powers the CLI for Packer, Consul, Vault, Terraform, Nomad, and more.

Features

  • Easy sub-command based CLIs: cli foo, cli bar, etc.

  • Support for nested subcommands such as cli foo bar.

  • Optional support for default subcommands so cli does something other than error.

  • Support for shell autocompletion of subcommands, flags, and arguments with callbacks in Go. You don't need to write any shell code.

  • Automatic help generation for listing subcommands.

  • Automatic help flag recognition of -h, --help, etc.

  • Automatic version flag recognition of -v, --version.

  • Helpers for interacting with the terminal, such as outputting information, asking for input, etc. These are optional, you can always interact with the terminal however you choose.

  • Use of Go interfaces/types makes augmenting various parts of the library a piece of cake.

Example

Below is a simple example of creating and running a CLI

package main

import (
	"log"
	"os"

	"github.com/hashicorp/cli"
)

func main() {
	c := cli.NewCLI("app", "1.0.0")
	c.Args = os.Args[1:]
	c.Commands = map[string]cli.CommandFactory{
		"foo": fooCommandFactory,
		"bar": barCommandFactory,
	}

	exitStatus, err := c.Run()
	if err != nil {
		log.Println(err)
	}

	os.Exit(exitStatus)
}