Gk Cli

🚀 GitKraken CLI

gk brings GitKraken to the command line. Its core functionality centers around "Work Items", which can be regarded as the feature or issue you're working on. This enables you to work with multiple repositories simultaneously, offering the same user experience as in a monorepo. We also offer robust AI-powered commit messages and Pull Request generation. Additionally, it provides an MCP server that simplifies working with git, your Issue, and git hosting providers.

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

🚀 Quick Start

gk is a powerful command - line tool that allows you to manage multiple repositories efficiently. You can start by exploring its core commands and workflows.

✨ Features

• Work Item - Centric: Focus on "Work Items" to handle features or issues across multiple repos.
• AI - Powered: Generate commit messages and Pull Requests with AI.
• MCP Server: A local, powerful, and easy - to - use MCP server that integrates with git, GitHub, and Jira.
• git Passthrough: Use gk to execute any git command.

📦 Installation

macOS

gk can be installed via Homebrew using the following command:

brew install gitkraken-cli

Alternatively, download it from the releases page and add it to your binaries folder:

mv ~/Downloads/gk /usr/local/bin/gk

Unix / Ubuntu

gk is available as a downloadable binary from the releases page. After downloading, add it to your binaries folder:

mv ~/Downloads/gk /usr/local/bin/gk

Or create a new directory, move the binary, and add it to $PATH:

mkdir "$HOME/cli"
mv ~/Downloads/gk "$HOME/cli"
export PATH="$HOME/gk:$PATH"

You can also [download][releases page] your corresponding package (.deb, .rpm) and install it with:

sudo apt install ./gk.deb

or

sudo rpm -i ./gk.rpm

Windows

gk can be installed from [Winget][winget] using the following command:

winget install gitkraken.cli

💻 Usage Examples

Basic Usage

Start with a single repository and follow these steps:

# Authenticate
gk auth login

# Navigate to a git repo directory on your filesystem
cd ./path/to/repo

# Then create a Work Item and the current directory
# will be automatically added to the Work Item
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

Advanced Usage

Once you're familiar with single - repo usage, you can work with multiple repos by adding them 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 already

You can also use gk to pass through any git command:

gk status
gk remote -v
# etc

📚 Documentation

gk help is your best resource for exploring the CLI. You can also refer to 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.

🔧 Technical Details

MCP Server

The GitKraken MCP server is a local, powerful, and user - friendly MCP server. It wraps git, GitHub, Jira MCP actions and provides tools for LLMs working with GitKraken APIs and functionality. You can find specific installation instructions based on your chosen AI application in the Help Center.

If you want to learn more about the MCP server, check out the introduction blog post

Configuration - Nerd Fonts

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

⚙️ Troubleshooting

gk login freezes after authenticating in browser

This issue is caused by the browser. Currently, Safari and Brave do not allow responses 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.

gk from Oh - My - Zsh

Oh - My - Zsh has gitk aliased as gk, which can cause problems. To fix this, run the following command in your terminal:

unalias gk

Manual macOS Installation

If you manually install the CLI from the releases page on macOS, you may encounter a security error 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.