gk is GitKraken on the command line. 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.
Check out the installation instructions and examples below. For command usage see the docs.
gk is available from Homebrew with the following command:
brew install gitkraken-cliOr download it from the releases page and add it to your binaries folder:
mv ~/Downloads/gk /usr/local/bin/gkgk is available as a downloadable binary from the releases page and add it to your binaries folder:
mv ~/Downloads/gk /usr/local/bin/gkgk is available from Winget with the following command:
winget install gitkraken.cliOr download it from the releases page and place the gk.exe in a desired folder.
Then edit your environment variables to add it to your PATH.
- In Search, search for Environment Variables.
- Click on the Edit the system environment variables result.
- In the modal, click on the Environment Variables... button.
- In the System Variables section, scroll until you find the PATH variable. Click on it.
- If it doesn't exist, create a variable with the name PATH.
- Add the path to the
gkbinary at the end.
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 Workspaces exist only on your machine.
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.
gk ws add-repo
This will add a new repo to a workspace either by path or remote URL.
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.
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.
gk ws [action]
In any workspace, you can perform git operations like fetch, pull, push, and checkout across all repos in the workspace.
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.
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.
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.
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
gk ws graph
Open a visual graph of the repo in your current directory in either GitKraken Client or GitLens in VS Code.