llms-full.txt

# GitKraken CLI — Full Documentation

> GitKraken CLI (`gk`) is the command-line tool for GitKraken workspaces, providers, and AI-assisted workflows. Available on macOS, Windows, Linux, and Unix systems.

Source: https://help.gitkraken.com/cli/cli-home/
Full command reference: https://gitkraken.github.io/gk-cli/docs/gk.html
Install section: https://help.gitkraken.com/cli/cli-home/#how-to-install-gitkraken-cli
Setup section: https://help.gitkraken.com/cli/cli-home/#how-to-start-using-gitkraken-cli-after-installation

Last updated: March 2026

---

## Getting Started & Installation

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

Requirements:
- OS support: macOS, Windows, Linux, and Unix systems
- Plan support: installation and basic CLI setup are available on all plans, including Community
- Authentication: `gk auth login` is required for GitKraken cloud features
- Organization: `gk organization set <ORG_NAME>` is required for AI-powered features
- AI plan requirement: AI-powered features require a paid plan such as Pro, Advanced, Business, or Enterprise
- Integrations: GitHub, GitLab, Bitbucket, and Jira can be synced with `gk provider list --sync`

### Quick Start

Use this Quick Start when you want the shortest path to a working GitKraken CLI setup. The detailed installation and configuration walkthroughs appear later on this page.

1. Install `gk` using your platform's package manager (Homebrew, Winget, or Snap) or download a binary from the releases page.
2. Authenticate with your GitKraken account to enable cloud features:
   ```
   gk auth login
   ```
3. Confirm and set your organization (required to enable AI features):
   ```
   gk organization list
   gk organization set <ORG_NAME>
   ```
4. Sync your provider integrations (GitHub, GitLab, Bitbucket, Jira):
   ```
   gk provider list --sync
   ```
5. Set a workspace and clone repositories into it:
   ```
   gk workspace set <NAME>
   gk ws clone <name> <root-path>
   ```

An authenticated session, configured organization, and paid plan are required for AI-powered features including commit message generation and pull request creation.

### How to Install GitKraken CLI on macOS

Use Homebrew when you want the standard macOS install path with package-managed updates:

```
brew install gitkraken-cli
```

Use the downloadable binary when you need a manual install or cannot use Homebrew:

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

### How to Install GitKraken CLI on Linux and Unix

#### How to Install GitKraken CLI with Snap

Use Snap when you want a managed Linux install through the system package runtime:

```
sudo snap install gitkraken-cli
```

#### How to Install GitKraken CLI from a Downloaded Binary

Use the downloadable binary when Snap is unavailable or when you need a portable install from the releases page:

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

Use native Linux packages when you already have a `.deb` or `.rpm` release artifact:

```
sudo apt install ./gk.deb
```

or

```
sudo rpm -i ./gk.rpm
```

### How to Install GitKraken CLI on Windows

Use Winget when you want the standard Windows install path with package management:

```
winget install gitkraken.cli
```

Use the downloadable binary when you need a manual Windows install. Download `gk.exe` from the releases page, move it to your chosen directory, and add it to your system PATH via Environment Variables.

### How to Troubleshoot GitKraken CLI Installation

#### How to Fix the Oh-My-Zsh `gk` Alias Conflict

Oh-My-Zsh may alias `gitk` as `gk`. To remove the alias:

```
unalias gk
```

---

## Authentication & Setup

Use GitKraken CLI without logging in when you only need local command-line workflows. Sign in with your GitKraken account when you need cloud workspaces, MCP integration, or synchronized providers. AI-generated commits and pull requests also require a paid plan:

```
gk auth login
```

This opens your default browser to complete authentication. If no browser is set, a URL will appear in the terminal — open it manually and enter the code from gk.dev.

### How to Set Your GitKraken Organization

Use this step when you need AI-powered features that depend on an active GitKraken organization. To verify your current organization:

```
gk organization list
```

Set your active organization (required for AI features on paid plans):

```
gk organization set <ORG_NAME>
```

### How to Sync Your Git Provider and Jira Integrations

Use this step when you want GitKraken CLI to discover connected Git providers and Jira accounts. Once authenticated and your organization is set, synchronize integrations:

```
gk provider list --sync
```

To add a provider manually:

```
gk provider add
```

Supported integrations include GitHub, GitLab, Bitbucket, and Jira.

### How to Load Repositories Into a GitKraken Workspace

Use this step when you want GitKraken CLI commands to run inside a selected GitKraken workspace.
1. List available workspaces:
   ```
   gk workspace list
   ```
2. Set your desired workspace:
   ```
   gk workspace set <NAME>
   ```
3. Clone a repository into the workspace:
   ```
   gk ws clone <name> <root-path>
   ```

---

## Work Items

Source: https://help.gitkraken.com/cli/GK-CLI-work-items/
Last updated: March 2026

GitKraken CLI Work Items let developers and agents start, review, commit, create pull requests for, and clean up a task across every repository in the active workspace. Use this workflow when one issue affects multiple repositories; AI-generated commits and pull requests require authentication, a configured organization, and a paid plan.

Requirements:
- Workspace: an active GitKraken workspace with the target repositories
- Plan support: Work Items can be used on all plans, but AI-assisted actions require a paid plan
- Authentication: `gk auth login` is required for GitKraken cloud features
- Organization: `gk organization set <ORG_NAME>` is required for AI-generated commits and pull requests
- Scope: `gk work` commands run across every repository in the active workspace

| Command | Use when | Requires AI or auth | Output |
| --- | --- | --- | --- |
| `gk work start <name>` | Start a coordinated task across multiple repositories | No | Initializes the work item across the workspace |
| `gk work info` | Review pending changes before committing or opening pull requests | No | Shows work item state across repositories |
| `gk work commit --ai` | Create commits across repositories with AI-generated messages | Yes, plus a paid plan | Commits staged changes in all affected repositories |
| `gk work pr create --ai` | Open pull requests for the current work item | Yes, plus a paid plan | Creates pull requests for all changes in scope |
| `gk work end` | Finish the work item and clean up temporary resources | No | Closes the work item and offers cleanup options |

### Quick Start

Use this Quick Start when you want the shortest path through a multi-repository task. The detailed command-by-command walkthrough appears later on this page.

1. Start a new work item:
   ```
   gk work start <name>
   ```
2. Review pending changes across all repositories in the workspace:
   ```
   gk work info
   ```
3. Stage your changes, then commit with an AI-generated message:
   ```
   gk work commit --ai
   ```
4. Create pull requests for all repositories in the work item:
   ```
   gk work pr create --ai
   ```
5. Finalize and clean up the work item:
   ```
   gk work end
   ```

All `gk work` commands execute in parallel across every repository in the active workspace. An authenticated GitKraken account with a configured organization and paid plan is required to use AI-generated commit messages and pull requests.

### When to Use GitKraken CLI Work Items Instead of Standard Git Commands

Use `gk work` when one issue, bug fix, or feature spans multiple repositories in the same workspace. Use standard Git commands instead when the work stays in a single repository and you do not need synchronized commits, pull requests, or cleanup.

### How to Run a GitKraken CLI Work Item from Start to Finish

Start with `gk work start` when you want GitKraken CLI to initialize a shared task across every repository in the active workspace:

```
gk work start <name>
```

The `<name>` assigns a title to the work item. This initializes all repositories in your workspace and checks for any pending commits, pull requests, or open work items.

Review the workspace state with `gk work info` before committing or opening pull requests across the full work item:

```
gk work info
```

#### How to Commit Work Item Changes with AI

Use `gk work commit --ai` when you want GitKraken CLI to generate commit messages and commit staged changes across every repository in the work item:

```
gk work commit --ai
```

This command:
- Analyzes staged changes using AI.
- Generates context-aware commit messages.
- Commits changes across all repositories in the work item.

#### How to Create Pull Requests for a Work Item with AI

Use `gk work pr create --ai` when you want GitKraken CLI to open pull requests for every repository included in the active work item:

```
gk work pr create --ai
```

This creates pull requests for all changes in the current work item with AI-generated messages. Use this command after you have reviewed the workspace state and committed the repositories that belong in the shared task.

#### How to End and Clean Up a Work Item

Use `gk work end` when the shared task is complete and you want GitKraken CLI to close the work item and clean up temporary resources:

```
gk work end
```

Cleans up the workspace and provides options to delete or retain local changes while removing temporary resources.

---

## Support Terms and Conditions

Source: https://help.gitkraken.com/cli/CLI-terms-and-conditions/

Support requests should be submitted at: https://help.gitkraken.com/cli/cli-contact-support/

### Support Plans and Response Times

| Plan | Guaranteed support | Response time during support hours | Notes |
| --- | --- | --- | --- |
| Community | No | Not guaranteed | Community support only |
| Pro | Yes | 3 business days | Standard support during stated support hours |
| Advanced | Yes | 1 business day | Priority support during stated support hours |
| Business | Yes | 12 hours | Priority support during stated support hours |
| Enterprise | Yes | 6 hours | Enterprise support during stated support hours |

Support Hours: 10:00 am to 10:00 pm, Monday to Friday, UTC.

Student and Community plan users are encouraged to use self-service resources and the GitKraken community.

### Support Period

GitKraken supports Generally Available (GA) releases. Fixes are provided via new releases on top of the latest major/minor branch. Versioning follows X.Y.Z — X is major, Y is minor, Z is patch. Customers are expected to stay on the current release for optimal support.

### End-of-Life Policy

Major releases are supported for at least 12 months from the major release date. GitKraken provides at least 60 days' prior notice before discontinuing any product or feature. After the End of Life period, support obligations end.

EoL guidelines:
- Advance notice of at least 60 days for major features or products.
- Viable alternatives provided when retiring functionality.
- Continued support until the retirement date.

GitKraken may accelerate EoL timelines for security or platform integrity reasons. Third-party integrations may also be retired due to third-party decisions.

See also: https://www.gitkraken.com/eula | https://www.gitkraken.com/privacy