cli

README

Callamary CLI

A simple CLI package for Golang project


. Report Bug . Request Feature

Simple CLI Package for Go Projects

This CLI package is designed to facilitate the integration of command-line interface (CLI) capabilities into Go projects, streamlining the process of implementing CLI commands.

How to use

Assuming that your CLI commands are located in a commands directory, you can utilize the package as follows:

/* commands/main.go */

func main() {

  cli.Command("hello", hello, "Greeting CLI command")
  ...

  cli.Run() // call run function at the bottom
}

func hello() {
  fmt.Println("Hello World")
}

Console Message

Showing message in terminal will be ease. For example you need to print error message in terminal, you can call:

Error

  cli.Error("Error", error)

Warning

  cli.Warning("Warning")

Success

  cli.Success("Success")

Build the commands

For the initial installation, you must manually build your executable by using the following command:

build -o ./call ./commands/main.go

After the executable has been generated, you can simply run

./call build

to incorporate any newly added commands in subsequent updates.

License

Callamary CLI is open-sourced software licensed under the MIT license.

Documentation

Index

• func Command(name string, fn func(), description string)
• func Error(message string, e error)
• func Run()
• func Success(message string)
• func Warning(message string)

Functions

func Command

func Command(name string, fn func(), description string)

Register command to be used in cli

func Error

func Error(message string, e error)

Print error message

func Run

func Run()

func Success

func Success(message string)

Print success message

func Warning

func Warning(message string)

Print warning message