https://github.com/olumidayy/go-github
A CLI tool for communicating with github.
https://github.com/olumidayy/go-github
api cli github go golang
Last synced: 5 days ago
JSON representation
A CLI tool for communicating with github.
- Host: GitHub
- URL: https://github.com/olumidayy/go-github
- Owner: olumidayy
- License: other
- Created: 2022-03-21T08:11:24.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-16T06:48:20.000Z (almost 2 years ago)
- Last Synced: 2025-09-02T11:56:56.873Z (5 months ago)
- Topics: api, cli, github, go, golang
- Language: Go
- Homepage:
- Size: 27.3 KB
- Stars: 16
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# go-github
### A [Golang](https://go.dev/) CLI tool built with [Cobra (& cobra-cli)](https://github.com/spf13/cobra).
## Pre-requisites
- [Go SDK](https://go.dev/dl/)
## Getting started
You can decide to do one of two things:
### 1. Clone the repository
```
$ git clone https://github.com/olumidayy/go-github.git
```
After cloning go-github, build the tool by running:
```
$ go build
```
To be able to use go-github globally, add it to your Go binaries using the `install` command.
```
$ go install
```
### 2. Install the tool directly in your project
```
$ go install github.com/olumidayy/go-github@latest
```
## Usage
There are two commands, `user` and `repo` (so far). The former fetches information about a particular user by passing their github username (compulsory), like so:
```
$ go-github user
```
Below is an example:
```
$ go-github user olumidayy
Just fetched olumidayy's data.
Name: Olumide Nwosu
Username: olumidayy
Followers: 55
Following: 19
Public Repositories: 26
Public Gists: 33
Location: Lagos, Nigeria
```
The `repo` command can be used in two ways:
- Passing just a username:
```
$ go-github repo
```
This returns the name and description of all the user's public repositories.
- Passing both a username and a repository name as arguments:
```
$ go-github repo
```
This is more specific and returns a summary of the repository in question.
These can be demonstrated as follows:
```
$ go-github repo olumidayy
Fetching olumidayy's repository data...
Name: bckdrp
Description: A GraphQL API for shortening URLs
Name: birthday_reminder
Description: Utility app to remind of loved ones' birthdays made with flutter.
.....
```
```
$ go-github repo olumidayy go-github
Fetching olumidayy's repository data...
Name: go-github
Description: A CLI tool for communicating with github.
Author: olumidayy
Language: Go
Stars: 13
Forks: 0
Watchers: 13
Year: 2022
```
## Contributions
Pull requests and contributions are very much welcome! 💙