gin

command module
v0.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 13, 2024 License: AGPL-3.0 Imports: 2 Imported by: 0

README

Git Issue Navigator (gin)

View the issues of a GitHub or GitLab repository directly from your command line.

Gif showing gin's functionality

Features

  • Browse all issues (open/closed) from both local and remote repositories
  • View the discussion for each issue
  • Discussions have fully rendered markdown as well as correctly colored tags

Installation

go install github.com/glad-dev/gin@latest

Usage

Configuring authentication tokens

Authenticate with the GiHub/GitLab APIs by importing tokens with gin config add. If $XDG_CONFIG_HOME is set, the tokens are stored at $XDG_CONFIG_HOME/gin/, otherwise ~/.config/gin is used.

Creating a GitLab token

Create a token with scopes read_api, read_user and read_repository in Preferences > Access Tokens.

Creating a GitHub token

Create a classic token with scopes repo and read_user in Settings > Developer settings > Personal access token.

Viewing issues
  • To view the issues of a remote repository, use gin issues --url https://github.com/path/to/your/repo.
  • To view the issues of the repository you're currently in, use gin issues

Acknowledgements

This project would not have been possible without charmbracelet and their bubbletea and glow libraries.

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL