gh

1.2.1 Opens a new window with list of versions in this module.

A Go module for interacting with gh and the GitHub API from the command line. For more information about how to use this package see README

Latest version published 2 years ago

GitHub

Package Health Score

62 / 100

security
No known security issues
popularity
Popular
maintenance
Inactive
community
Active

Popularity

Popular

Imported By: 176
GitHub Stars: 318
Forks: 46
Contributors: 30

Usage Popularity

Based on project statistics from the GitHub repository for the Golang package gh, we found that it has been 318 times.

The popularity score for Golang modules is calculated based on the number of stars that the project has on GitHub as well as the number of imports by other modules.

Security

No known security issues

Security risks

Direct Vulnerabilities: 0
C
0
H
0
M
0
L

Indirect Vulnerabilities: Check with Snyk

Release Date

Feb 27, 2023

License

MIT

Security Policy

We found a way for you to contribute to the project! Looks like gh is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Inactive

Commit Frequency

Open Issues: 11
Open PR: 5
Last Release: 2 years ago
Last Commit: 6 months ago

Further analysis of the maintenance status of github.com/cli/go-gh based on released golang versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for github.com/cli/go-gh is that it hasn't seen any new versions released to golang in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 30
Funding: No

With more than 10 contributors for the github.com/cli/go-gh repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Keep your project healthy

Check your go.mod

Ensure all the packages you're using are healthy and well-maintained

Readme

Go library for the GitHub CLI

go-gh is a collection of Go modules to make authoring GitHub CLI extensions easier.

Modules from this library will obey GitHub CLI conventions by default:

repository.Current() respects the value of the GH_REPO environment variable and reads from git remote configuration as fallback.
GitHub API requests will be authenticated using the same mechanism as gh, i.e. using the values of GH_TOKEN and GH_HOST environment variables and falling back to the user's stored OAuth token.
Terminal capabilities are determined by taking environment variables GH_FORCE_TTY, NO_COLOR, CLICOLOR, etc. into account.
Generating table or Go template output uses the same engine as gh.
The browser module activates the user's preferred web browser.

Usage

See the full go-gh reference documentation for more information

package main

import (
	"fmt"
	"log"
	"github.com/cli/go-gh/v2"
	"github.com/cli/go-gh/v2/pkg/api"
)

func main() {
	// These examples assume `gh` is installed and has been authenticated.

	// Shell out to a gh command and read its output.
	issueList, _, err := gh.Exec("issue", "list", "--repo", "cli/cli", "--limit", "5")
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(issueList.String())

	// Use an API client to retrieve repository tags.
	client, err := api.DefaultRESTClient()
	if err != nil {
		log.Fatal(err)
	}
	response := []struct{
		Name string
	}{}
	err = client.Get("repos/cli/cli/tags", &response)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(response)
}

See examples for more demonstrations of usage.

Contributing

If anything feels off, or if you feel that some functionality is missing, please check out our contributing docs. There you will find instructions for sharing your feedback and for submitting pull requests to the project. Thank you!

FAQs

What is gh?

A Go module for interacting with gh and the GitHub API from the command line. . Visit Snyk Advisor to see a full health score report for gh, including popularity, security, maintenance & community analysis.

Is gh popular?

The golang package gh receives a total of ? weekly downloads. As such, gh popularity was classified as a popular. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is gh well maintained?

We found indications that gh is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is gh safe to use?

The golang package gh was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 25 October-2024, at 02:01 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP