github-go-cli

README

github-go-cli

• github-go-cli provides an executable called github-go-cli, that can be used to access all of GitHub’s public API functionality from your command-line

• github-go-cli is written on top of cobra library. Cobra is used in many Go projects such as Kubernetes, Hugo, and GitHub CLI to name a few.

Overview

• github-go-cli works based on that structure:

Instalation

Manual

Go to the releases page and download the latest one for your platform.

Usage

github-go-cli [command] [--flags]

• Get user informations:

github-go-cli describe user brendangregg

output:

Name              Location
Brendan Gregg     Sydney, Australia

• Get user followers:

github-go-cli list followers brendangregg

output:

Name               Github Link
joaovitor          https://github.com/joaovitor
marcinpohl         https://github.com/marcinpohl
dacresni           https://github.com/dacresni
toke               https://github.com/toke
nyxwulf            https://github.com/nyxwulf
sanga              https://github.com/sanga
jacques            https://github.com/jacques
nicoulaj           https://github.com/nicoulaj
adulau             https://github.com/adulau
adragomir          https://github.com/adragomir
mrluanma           https://github.com/mrluanma
MiloCasagrande     https://github.com/MiloCasagrande
JonGretar          https://github.com/JonGretar
mburns             https://github.com/mburns
yrcjaya            https://github.com/yrcjaya
zdk                https://github.com/zdk
jailton            https://github.com/jailton
openweb            https://github.com/openweb
bartman            https://github.com/bartman
narkisr            https://github.com/narkisr
gburd              https://github.com/gburd
evanfarrar         https://github.com/evanfarrar
jf                 https://github.com/jf
jage               https://github.com/jage
huangliang2211     https://github.com/huangliang2211
filipeamoreira     https://github.com/filipeamoreira
igungor            https://github.com/igungor
johnm              https://github.com/johnm
meangrape          https://github.com/meangrape
liwei              https://github.com/liwei

Get Help

github-go-cli --help

output:

Access all of GitHub’s public API functionality from your command-line

Usage:
  github-go-cli [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  describe    Retrieve detailed information about any object
  help        Help about any command
  list        Retrieve user profile information such as name, location, public repos, followers, following

Flags:
      --config string   config file (default is $HOME/.github-go-cli.yaml)
  -h, --help            help for github-go-cli
  -t, --toggle          Help message for toggle

Use "github-go-cli [command] --help" for more information about a command.

ToDo

• Improve tests
• CLI auto-completion
• New functions

Documentation

Overview

Copyright © 2022 Lucas Afonso Kremer

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.