How to add CLI subcommands in Go with Cobra

I made a small repo called good to regroup CLI commands and packages I like to use in Go:

jmau111
/
good

Personal playground composed of CLI commands made in Go.

…


This content originally appeared on DEV Community 👩‍💻👨‍💻 and was authored by jmau111⭐

I made a small repo called good to regroup CLI commands and packages I like to use in Go:

GitHub logo jmau111 / good

Personal playground composed of CLI commands made in Go.

Everything looks Good

Personal playground composed of CLI commands made in Go.

Disclaimer

Hacking cmd are provided for convenience and ethical hacking only. Don't use it to hack without explicit authorization (e.g., illegal activities).

Prerequisites

Install Go

Add these lines to your .bashrc or .zshrc:

export GOPATH=$HOME/go
export PATH=$PATH:$GOROOT/bin:$GOPATH/bin

List of available commands

Fun commands

  • good fun catfact: get absolutely essential facts about cats
  • good fun kanji: get meanings and other info about a specific kanji
  • good fun spinthewheel: Don't know what to decide? Maybe leave it to chance...
  • good fun 1337: Convert a string to leetspeak and shine on Internet

Checking tools

  • good check archi: check your architecture with the Topology function
  • good check bios: check your BIOS
  • good check chassis: check your chassis info
  • good check cpu: check your CPU
  • good check gpu: check your GPU
  • …
View on GitHub

It's a mix of hacks and more "advanced" integrations to be used as CLI commands in the terminal.

I used Cobra, an incredible library to write CLI applications in Go.

Their documentation is pretty good and the package is quite easy to use. I had the need to "categorize" my commands, though. I don't pretend it's the best way to do it, but I like to use subcommands for that.

For example, in my repo, I use 3 categories:

  • fun
  • check
  • hack

Cobra is very cool, as it automates lots of tasks in the terminal (usages, man documentation, suggestions, etc) and improves the user experience while abstracting the difficulty of developing CLI commands in Go. The following commands will display all CLI available for fun, checking hardware, and hacking:

good fun
good check
good hack

It's helpful even for me, as a maintainer.

To add subcommands, you can write the following in your package:

var rootCmd = &cobra.Command{
    Use:   "mycommand",
    Short: "short description",
}

var subCmd = &cobra.Command{
    Use:   "mysubcommand",
    Short: "short description",
}

and then in the init function:

func init() {
    rootCmd.AddCommand(subCmd)
}

Users can type mycommand and get mysubcommand as a recommended usage.

Then, if I want to add a subcommand for mysubcommand, I can register it like that:

subsubcommand = &cobra.Command{
   Use:   "subsubcommand",
   Short: "short description",
}

mysubcommand.AddCommand(subsubcommand)


This content originally appeared on DEV Community 👩‍💻👨‍💻 and was authored by jmau111⭐


Print Share Comment Cite Upload Translate Updates
APA

jmau111⭐ | Sciencx (2022-09-25T21:39:46+00:00) How to add CLI subcommands in Go with Cobra. Retrieved from https://www.scien.cx/2022/09/25/how-to-add-cli-subcommands-in-go-with-cobra/

MLA
" » How to add CLI subcommands in Go with Cobra." jmau111⭐ | Sciencx - Sunday September 25, 2022, https://www.scien.cx/2022/09/25/how-to-add-cli-subcommands-in-go-with-cobra/
HARVARD
jmau111⭐ | Sciencx Sunday September 25, 2022 » How to add CLI subcommands in Go with Cobra., viewed ,<https://www.scien.cx/2022/09/25/how-to-add-cli-subcommands-in-go-with-cobra/>
VANCOUVER
jmau111⭐ | Sciencx - » How to add CLI subcommands in Go with Cobra. [Internet]. [Accessed ]. Available from: https://www.scien.cx/2022/09/25/how-to-add-cli-subcommands-in-go-with-cobra/
CHICAGO
" » How to add CLI subcommands in Go with Cobra." jmau111⭐ | Sciencx - Accessed . https://www.scien.cx/2022/09/25/how-to-add-cli-subcommands-in-go-with-cobra/
IEEE
" » How to add CLI subcommands in Go with Cobra." jmau111⭐ | Sciencx [Online]. Available: https://www.scien.cx/2022/09/25/how-to-add-cli-subcommands-in-go-with-cobra/. [Accessed: ]
rf:citation
» How to add CLI subcommands in Go with Cobra | jmau111⭐ | Sciencx | https://www.scien.cx/2022/09/25/how-to-add-cli-subcommands-in-go-with-cobra/ |

Please log in to upload a file.



There are no updates yet.
Click the Upload button above to add an update.

You must be logged in to translate posts. Please log in or register.

Related Posts