Skip to content

Master multi-repo workflows, synchronize on PRs & Issues, and integrate seamlessly with GitKraken Client & GitLens for VS Code for instant Git visualization.

License

Notifications You must be signed in to change notification settings

gitkraken/gh-gk

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

9 Commits
Β 
Β 
Β 
Β 

Repository files navigation

πŸš€ GitKraken CLI Extension

gk is the GitKraken command line extension to GitHub CLI (gh). It makes working across multiple repos easier with Workspaces, provides access to pull requests and issues from multiple services (GitHub, GitLab, Bitbucket, etc.), and seamlessly connects with GitKraken Client and GitLens in VS Code to visualize git information when you need it.

GitKraken CLI is available on macOS, Windows and Unix systems.

πŸ“š Documentation

Check out the installation instructions and examples below. For command usage see the docs.

Installation

 gh extension install gitkraken/gh-gk

Updating extension

gh extension upgrade gitkraken/gh-gk

Uninstalling extension

gh extension remove gitkraken/gh-gk

βš™οΈ Configuration

Nerd Fonts

The GitKraken CLI supports Nerd Fonts to display icons for some commands. To ensure correct icon rendering, please obtain and install a Nerd Font available at https://www.nerdfonts.com/. After installation, set the selected Nerd Font as the default font for your terminal.

Examples

🎯 Focus View

gh gk focus

GitKraken Focus View is a unified dashboard that consolidates PRs, Issues, and WIPs across all of the repositories in a Cloud Workspace. You can view the details of any item and take action on your most important tasks.

gk-focus-screenshot

Pin items to keep them at the top of your list

Use the shortcut p to pin any PR or Issue to the top of the list. You can unpin an item by using the same shortcut on any pinned item.

Snooze items to save them for later

Use the shortcut s to snooze any PR or Issue, removing them from the list of items. You can view snoozed items by navigating to the Snoozed tab in the Focus View. You can unsnooze items and bring them back into your Focus View lists by using the same shortcut on any snoozed item.

🀝 Create Workspaces to group repos

gh gk ws create

GitKraken workspaces associate groups of repos and set the context for helpful commands that can operate on, or get information for, multiple repos at once. There are two types of workspaces:

Local

Local Workspaces exist only on your machine.

Cloud

Cloud Workspaces are accessible on any machine, and can be connected to hosting and issue providers like GitHub and GitLab to get additional information about pull requests and issues. Share Cloud Workspaces with your team to improve onboarding with the ability to clone all repos at once. To enable this extra functionality, Cloud Workspaces require a free GitKraken account. We are continuing to evolve and improve GitKraken Workspaces and welcome any feedback.

Screenshot 2023-12-22 at 10 34 29β€―AM

Adding and locating repos

gh gk ws add-repo

This will add a new repo to a workspace either by path or remote URL.

gh gk ws locate

If you're accessing a Cloud Workspace for the first time, you might need to locate the local repos on your machine. Run this command in the directory where youre repos are located so gk knows where they are.

gh gk ws clone

You can also clone all repos in a Workspace at once into a single directory. This is helpful for onboarding when your team works on multiple repos.

🎬 Perform git actions on multiple repos at once

gh gk ws [action]

In any workspace, you can perform git operations like fetch, pull, push, and checkout across all repos in the workspace.

πŸ“‹ Get pull requests and issues

gh gk provider add

Before fetching pull requests and issues, ensure that you have the appropriate provider (GitHub, GitLab, etc.) connected. This will open a browser to authenticate.

gh gk pr list

When a Cloud Workspace has a provider connected, you can list all pull requests and issues for repos in the workspace, and view details for a specific one.

gh-gk-pr-list-screenshot

gh gk pr view

Returns a list of all pull requests for all repos in a workspace. Type to search for a specific pull request and press enter to view details.

Screenshot 2023-12-22 at 10 22 30β€―AM

πŸ“ˆ Pull Request Insights

gh gk ws insights

See the following metrics for all repositories in a Cloud Workspace. The default time period is 7 days, but can be increased to 14 days with any paid GitKraken license.

  • Average Cycle Time
  • Average Throughput
  • Merge Rate
  • Opened Pull Requests
  • Merged Pull Requests
  • Closed Pull Requests

gh-gk-insights-screenshot

✨ Visual Commit Graph

gh gk graph

Open a visual graph of the repo in your current directory in either GitKraken Client or GitLens in VS Code.

gh-gk-graph-demo.mov

About

Master multi-repo workflows, synchronize on PRs & Issues, and integrate seamlessly with GitKraken Client & GitLens for VS Code for instant Git visualization.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published