gk is GitKraken on the command line. The core functionality is focused on "Work Items" which can be thought of as the feature or issue you are trying to tackle. This allows you to work with multiple repos at once and get the same UX as if you were in a monorepo. We also provide robust AI-powered commit messages and Pull Request generation.
GitKraken CLI is available on macOS, Windows, and Unix systems.
gk help is your best source for exploring the CLI. But also see the workflows below.
Welcome to GitKraken CLI, a premium CLI experience for managing multiple repositories with familiar GIT CLI commands
Usage:
gk [flags]
gk [command]
AUTHENTICATING
auth Authenticate with the GitKraken platform
provider Add or remove provider tokens
CORE COMMANDS
graph Display commit graph in current repository
issue Manage your issues
organization Manage your Gitkraken organizations
work Interact with your work.
workspace Interact with your workspaces. Alias: 'ws'
Additional Commands:
help Help about any command
setup Display information about your current system configuration
version Print the version number of GK CLI
Flags:
-h, --help help for gk
Use "gk [command] --help" for more information about a command.Start with a single repo. You can add more later.
In general, your process will look like this:
# Authenticate
gk auth login
# Navigate to a git repo directory on your filesystem
cd ./path/to/repo
# Create a Work Item - the current directory will be automatically added
gk work create "My new work item"
# Edit files...
# ...
# Commit your changes using AI
gk work commit --ai
# Push your changes
gk work push
# Create a Pull Request
gk work pr create --ai
Once you have familiarized yourself with using a single repo, try out creating work items and generating commits and PRs for multiple repos at a time by just adding multiple repos to a new Work Item.
# Add a repo to the current work item
gk work add ./path/to/repo # path could be as simple as "." if you are in the directory alreadyYou can also use gk to pass through any git command. eg:
gk status
gk remote -v
# etcAll binaries can be found on the [releases page][]. Make sure you select the binary for your OS(Linux/Mac/Windows) and CPU architecture (arm64/x86_64/i386).
If you have the original GitKraken CLI installed, you can use the following command to upgrade to the latest version:
brew uninstall gitkraken-cligk is available as a downloadable binary from the [releases page][].
Download it from the [releases page][], unzip it, and add it to your binaries folder.
Note: The downloaded binary will have a platform-specific name, such as gk-darwin-amd64 or gk-linux-arm64. You should rename it to gk before moving it to /usr/local/bin, or adjust the command below to use the actual filename.
# Example if your downloaded file is named 'gk-darwin-amd64'
mv ~/Downloads/gk-darwin-amd64 ~/Downloads/gk
sudo mv ~/Downloads/gk /usr/local/bin/gkThen, make sure it's executable:
chmod +x /usr/local/bin/gkTest the installation by running gk setup.
You will likely run into a security error that looks like this:
To fix this, go to Settings > Security & Privacy > General and click "Allow Anyway".
Try running gk setup again and then click "Open Anyway" to continue.
gk help is going to be your best source for exploring the CLI. But also see the workflows below.
Welcome to GitKraken CLI, a premium CLI experience for managing multiple repositories with familiar GIT CLI commands
Or create a new directory, move the binary and add it to $PATH:
```bash
mkdir "$HOME/cli"
mv ~/Downloads/gk "$HOME/cli"
export PATH="$HOME/gk:$PATH"AUTHENTICATING auth Authenticate with the GitKraken platform provider Add or remove provider tokens
sudo apt install ./gk.debor
sudo rpm -i ./gk.rpmTo enable auto-completion for gk in PowerShell, follow these steps:
Create and Save the Install Scripts Appendix section with script files:
- Change to the directory where update-profile.ps1 is located
cd "C:\Path\To\gkcli-update-profile.ps1"- Run the script to update the profile and sign the auto-completion script
.\gkcli-update-profile.ps1- Restart PowerShell to apply the changes.
- Change to the directory where uninstall-profile.ps1 is located
cd "C:\Path\To\gkcli-uninstall-profile.ps1"- Run the script to remove the auto-completion setup
.\gkcli-uninstall-profile.ps1- Restart PowerShell to apply the changes.
Or download the binary 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.
This problem is due to the browser. Currently we know that Safari and Brave do not allow to respond to localhost through port 1314. To fix this, change your default browser or copy the URL before the redirect and open it in another browser.
Oh-My-Zsh has gitk aliased as gk and that can create some problems. To fix this, type in your terminal:
unalias gk
If you encounter any bugs, please submit them to our Support Portal.
General feedback and suggestions during testing can be submitted via the "#ambassadors" channel in the GitKraken Community Slack as well as via this Google Form. We will also send a final feedback form at the end of the testing phase.