gk-cli

🚀 GitKraken CLI

gk 是命令行版本的 GitKraken。其核心功能聚焦于“工作项”，你可以将其视为你正在处理的功能或问题。这使你能够同时处理多个仓库，并获得与在单仓库中工作相同的用户体验。我们还提供强大的由人工智能驱动的提交消息和拉取请求生成功能。此外，它还提供了一个 MCP 服务器，可简化与 Git 以及你的问题和代码托管平台的协作。

GitKraken CLI 可在 macOS、Windows 和 Unix 系统上使用。

📚 目录

• MCP 服务器
• 文档说明
• 工作流程
• git 命令透传
• 安装步骤
• 故障排除
• 技术支持

🛠️ MCP 服务器

GitKraken MCP 服务器是一个强大且易于使用的本地 MCP 服务器。它封装了 Git、GitHub、Jira MCP 操作，并为使用 GitKraken API 和功能的大语言模型提供工具。你可以在 帮助中心 中找到根据你选择的人工智能应用的具体安装说明。

如果你想了解更多关于 MCP 服务器的信息，可以查看 介绍博客文章。

📖 文档说明

gk help 是探索该 CLI 的最佳资源。同时也可查看下面的 工作流程。

欢迎使用 GitKraken CLI，这是一款高级 CLI 工具，可使用熟悉的 GIT CLI 命令管理多个仓库

用法:
  gk [标志]
  gk [命令]

认证相关命令
  auth         使用 GitKraken 平台进行认证
  provider     添加或移除平台令牌

核心命令
  graph        显示当前仓库的提交图
  issue        管理你的问题
  organization 管理你的 Gitkraken 组织
  work         与你的工作进行交互
  workspace    与你的工作区进行交互。别名: 'ws'

其他命令:
  help         获取任何命令的帮助信息
  setup        显示当前系统配置信息
  version      打印 GK CLI 的版本号

标志:
  -h, --help   获取 gk 的帮助信息

使用 "gk [命令] --help" 可获取有关命令的更多信息。

🔨 工作流程

从单个仓库开始使用，你可以在之后添加更多仓库。

一般来说，你的操作流程如下：

# 进行认证
gk auth login

# 导航到文件系统中的 Git 仓库目录
cd ./path/to/repo

# 然后创建一个工作项，当前目录将自动添加到该工作项中
gk work create "My new work item"

# 编辑文件...
# ...

# 使用人工智能提交更改
gk work commit --ai

# 推送更改
gk work push

# 创建拉取请求
gk work pr create --ai

一旦你熟悉了使用单个仓库，就可以尝试通过将多个仓库添加到一个新的工作项中，同时为多个仓库创建工作项、生成提交和拉取请求。

# 将一个仓库添加到当前工作项中
gk work add ./path/to/repo # 如果你已经在该目录中，路径可以简单地写成 "."

🪄 git 命令透传

你也可以使用 gk 来透传任何 git 命令。例如：

gk status
gk remote -v
# 等等

📦 安装步骤

macOS

可以使用以下命令通过 Homebrew 安装 gk：

brew install gitkraken-cli

或者从 发布页面 下载并将其添加到二进制文件夹中：

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

Unix / Ubuntu

可以从 发布页面 下载 gk 的二进制文件。下载完成后，将其添加到二进制文件夹中：

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

或者创建一个新目录，将二进制文件移动到该目录并将其添加到 $PATH 中：

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

你也可以 下载 相应的软件包（.deb、.rpm）并使用以下命令进行安装：

sudo apt install ./gk.deb

或者

sudo rpm -i ./gk.rpm

Windows

可以使用以下命令通过 Winget 安装 gk：

winget install gitkraken.cli

⚙️ 配置说明

奈尔德字体

GitKraken CLI 支持使用奈尔德字体来为某些命令显示图标。为确保图标正确渲染，请从 https://www.nerdfonts.com/ 获取并安装奈尔德字体。安装完成后，将所选的奈尔德字体设置为终端的默认字体。

🐞 故障排除

gk login 在浏览器认证后冻结

此问题是由浏览器导致的。目前我们知道 Safari 和 Brave 不允许通过端口 1314 响应本地主机。要解决此问题，请更改默认浏览器，或者在重定向之前复制 URL 并在另一个浏览器中打开。

Oh-My-Zsh 中的 gk 问题

Oh-My-Zsh 将 gitk 别名为 gk，这可能会导致一些问题。要解决此问题，请在终端中输入：

unalias gk

macOS 手动安装问题

如果你在 macOS 上从发布页面手动安装 CLI，可能会遇到如下安全错误：

要解决此问题，请转到“设置”>“安全与隐私”>“通用”，然后点击“仍要允许”。

再次尝试运行 gk setup，然后点击“仍要打开”以继续。

📞 技术支持

如果你在使用过程中遇到任何问题或需要进一步的帮助，请随时联系我们的技术支持团队。