gennaro-tedesco / gh-f Goto Github PK

View Code? Open in Web Editor NEW

245.0 2.0 10.0 112 KB

🔎 the ultimate compact fzf gh extension

License: The Unlicense

Shell 100.00%

gh-extension command-line github git shell

gh-f's Introduction

the ultimate compact fzf gh extension

Installation • Usage • Customisation • Feedback

gh-f is the ultimate, compact and snappy fzf extension for gh cli. It addresses most of your daily GitHub workflow, if not all of it: f stands for filter, fzf or fomething felse.

Installation

gh extension install gennaro-tedesco/gh-f

Requirements

fzf
gnu core utils
bat (optional, if not detected it uses less as a pager, instead)

Usage

Get started!

gh f

shows the help page. Or watch it in action:

or a quick replay

gh f [cmd]

takes one of the following arguments or flags

command	description	binds
-a, adds	add files to staging area	enter: add files to staging area ctrl-d: diff selected file
-r, runs	show github workflow runs and filter logs	enter: search run logs
-g, greps	grep in files in revision history	interactive prompt: insert regex, select files, show pattern in revision history
-p, prs	view, diff and checkout PR	enter: checkout selected PR ctrl-d: diff selected PR ctrl-v: view selected PR
-b, branches	checkout and diff branches	enter: checkout selected branch ctrl-d: diff selected branch ctrl-x: delete selected branch
-l, logs	view, diff and checkout from logs history	enter: checkout selected commit ctrl-d: diff selected commit ctrl-v: view commit patch
-t, tags	checkout and diff version tags	enter: checkout tag in detached HEAD ctrl-d diff against current branch
-s, search	search issues in any repository	interactive prompt: follow instructions
-m, myissue	search issues you opened somewhere	interactive prompt: follow instructions
-k, pick	cherrypick files between branches	enter: checkout cherrypicked files from branch
-e, envs	show git config list	enter: print selected config variable
-h, help	show help page
-V, version	print the current version

Most commands follow the semantics of git standard instructions (so that you can remember them easily), only we append an s to avoid conflicts, should you have those commands lying around in the shell as aliases or for scripting.

Customisation

If you want to skip typing gh f before each command you may alias it directly, for instance

gh alias set prs 'f -p' # show PRs
gh alias set l 'f -l' # show git logs

and likewise for the rest.

The prompt colours are defined via their ANSI sequences here: change yourself accordingly, if you like different ones. Moreover notice that the rendering of text in the fzf preview window follows the options set in the FZF_DEFAULT_OPTS env variable: if you want to replicate exactly what is shown in the demo, here are my settings.

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-i to search for github issues with interactive prompt

gh-f's People

Contributors

Stargazers

Watchers

Forkers

u240 kjm0001 rednixon paul-sachs mattbaker fairhopeweb 0xack13 gbirke taiki45 sambacha

gh-f's Issues

sorry for issue.

I want to add this spin on my little script but I don't know how to add it. please could you show me the code. Please

"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

[advice] Make fzf more robust

I advice change 12 fzfs to fzf -d' 's. Because fzf will be affected by $FZF_DEFAULT_OPT. If user use -d: or other -d, it will make fzf work abnormally.

Thanks.

[feature] Add support for checking out from logs

First i'd like to say I love this thing ❤️ . It makes working with git branches so much easier.

One of the things I immediately tried was gh f -l and checkout a given entry (often to check for a bug or reset to a sane state). This would be a super useful to be able to add a command to checkout from a log entry (with ctrl+k or something... not sure yet)

That said, my bash-fu is pretty terrible. I'll try to mangle together a PR to add that but figured I'd raise this first to see if it makes sense.

[Feature] Add command to show where source file is

Love the tool, thank you for building it! I want to edit the colors directly on the source code, but I can't figure out where to find the source code 🤷‍♂️