The gh-i from gennaro-tedesco

gh-i's Introduction

search your github issues interactively

Installation • Usage • Feedback

Search GitHub issues interactively from the command line. Where did you open that bug report three weeks ago? And how many feature requests are still open in your organisation 🤔?

...well say no more:

Installation

gh extension install gennaro-tedesco/gh-i

This being a gh extension, you of course need gh cli as prerequisite.

Usage

Get started!

gh i

Without any flags gh i shows all the issues created by yourself in order of last update: this is in the vast majority of cases what you are after, is it not? To refine the search, however, the following flags are availabe

gh i [flag]

takes one of the following arguments or flags

flags	description	example
--me	only show issues created by yourself	gh i --me=false default to true
-s, --state	search issues by state (open, closed)	gh i -s closed default to none, namely both
-t, --title	search for issue title	gh i -t bug-fix
-b, --body	search in issue body	gh i -b "not working"
-u, --user	search in repos owned by user only	gh i --me -u @me
-l, --label	search for issues by label	gh i -l bug -l fix (AND) gh i -l bug,fix (OR)
-c, --colour	change colour of the prompt	gh i -c magenta
-h, --help	show the help page	gh i -h
-o, --output	print the output to console default to false, namely open in the browser	gh i -u @me -o
-V, --version	print the current version	gh i -V

gh-i provides the user with visual output of the selected query in human readable format (according to the list of chosen flags):

$ gh i -s open -u @me --me=false
╭──────────────────────────────────────────────╮
│  state:open + author:any + where:your repos  │
╰──────────────────────────────────────────────╯
...

as well as inline overlay of issue status when browsing through the selection list.

The prompt accepts the following navigation commands:

key	description
arrow keys	browse results list
`/`	toggle search in results list
`enter (<CR>)`	open issue in browser or return its URL as output (if `-o`)

Execute commands

gh-i must be intended as a filter, to browse the issues you created; as such, the best and most flexible way to execute commands with the results is to pipe it into and from stdin/stdout. This said, since in most cases one just wants to view and open the corresponding issue, we default to this action, namely upon selection the issue is opened in the web browser; to override this behaviour and return the output instead, use the -o flag.

Check the Wiki for more example and the most common use cases!

Feedback

If you find this application useful consider awarding it a ⭐, it is a great way to give feedback! Otherwise, any additional suggestions or merge request is warmly welcome!

See also the complete family of extensions

gh-s to search for repositories with interactive prompt
gh-f to snap around your git worfklow with fzf

gh-i's People

Contributors

Stargazers

Watchers

gh-i's Issues

"Add support for secure token storage"

Token storage change in latest release of gh

This is a message from the GitHub CLI team, maintainers of gh, writing to inform you that the most recent release of gh contains changes which may affect your extension. The latest release introduces the feature of storing authentication tokens in the system keyring (encrypted storage) instead of in a plain text file.
The keyrings that are supported are:

Keychain on macOS
GNOME Keyring on Linux (Secret Service dbus interface)
Wincred on Windows

This has huge security benefits for the users of our tool and was one of our oldest outstanding issues. Unfortunately this change has the potential to break extensions that rely on utilizing the users authentication token to work.

In order to have continued compatibility with gh there are some actions you, as an extension author, need to take. These actions will depend on the implementation of your extension.

Extensions built in Go using go-gh:

Upgrade your go-gh version to v1.2.1, the latest version.
- This can be done using go get github.com/cli/[email protected]
Verify that in your extension retrieval of the user authentication token is done using the auth.TokenForHost function.
- If you were previously accessing the authentication token using any other method it will no longer work.
- Automatic resolution of the authentication token when using the API clients will continue to work without changes.

All other extensions:

Verify that in your extension retrieval of the user authentication token is done by shelling out to the gh auth token command.
- If you were previously accessing the authentication token using the gh config get command, reading the configuration file directly, or any other methods it will no longer work.

As of right now storing the authentication token in the system keyring is an opt-in feature, but in the near future it will be required and at that point if the changes above are not made then your extension will be broken for all users. If you have any questions/concerns about this change please feel free to open a discussion in the gh repo.

Thanks,
The GitHub CLI Team

gennaro-tedesco / gh-i Goto Github PK