# @gitkraken/gk 中文文档

规范地址：https://npmcn.com/package/%40gitkraken/gk/

版本：3\.1\.77
npm 元数据更新时间：2026-10-14T08:41:48.727Z
中文译文更新时间：2026-11-16T10:51:52.590Z
软件包许可：CC-BY-3\.0-US

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40gitkraken/gk
原文对照：https://npmcn.com/package/%40gitkraken/gk/?lang=original
项目主页：https://www.gitkraken.com/
源码仓库：https://github.com/gitkraken/gk-cli

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：20.3 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：3 个
- 首次发布：2025-10-16T19:08:23.840Z
- 最新版本发布：2026-10-14T08:41:48.520Z
- 近 30 天下载量：319809（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：22（近 12 个月 17 个）

## 中文简介

gk是命令线上的GitKraken. 它使跨多个重置功能与Workspace更容易工作,提供了从多个服务(GitHub,GitLab,Bitbucket等)中调取请求和问题的访问权限,并与GitKraken客户端和Git无缝连接

## 安装

```sh
npm install @gitkraken/gk
```

也可以使用：`pnpm add @gitkraken/gk`、`yarn add @gitkraken/gk`、`bun add @gitkraken/gk`

## README

# GitKraken 磁共振 服务器

GitKraken MCP服务器是一个本地的MCP服务器,强大而易于使用. 它结合了您所有 GitKraken 集成的功能, 并为您的 AI 代理,助手, 和聊天员提供这种权力. 你的代理工作流程将更有能力,效率更高.

### 使用大小写

-   安全 Git 操作: 执行 安全可靠地进行Git行动
-   发行和PR自动化:在所有支持的GitKraken集成(GitHub,GitLab,BitBucket,Azure DevOps,Jira,Trello,Linear等)中读取和创建问题并拉出请求
-   了解 Repo 更改: 详细概述存储器中的所有更改并了解每个更改的影响

* * *

## 本地 GitKraken MCP 服务器

[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install_Server-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://gitkraken.dev/deeplink?product=gitlens&path=/link/command/install-mcp&ide=vscode&__hstc=91416005.36b7b55e451d23c79de91bbf539cbdd9.1710276073503.1760514722070.1760597038071.206&__hssc=91416005.2.1760597038071&__hsfp=2819208119&_gl=1*1czyc4g*_gcl_au*Njc0MDYxMzMzLjE3NTkxNzUzMDk.*_ga*MjA4ODE0MDQ0NC4xNzEwOTU1MTc3*_ga_TTGBQHQ5E4*czE3NjA1OTcwMzgkbzMwMSRnMSR0MTc2MDU5NzA0MSRqNTckbDAkaDE5OTY1ODc1OTc.) [![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install_Server-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://gitkraken.dev/deeplink?product=gitlens&path=/link/command/install-mcp&ide=vscode-insiders&__hstc=91416005.36b7b55e451d23c79de91bbf539cbdd9.1710276073503.1760514722070.1760597038071.206&__hssc=91416005.2.1760597038071&__hsfp=2819208119&_gl=1*vo5djr*_gcl_au*Njc0MDYxMzMzLjE3NTkxNzUzMDk.*_ga*MjA4ODE0MDQ0NC4xNzEwOTU1MTc3*_ga_TTGBQHQ5E4*czE3NjA1OTcwMzgkbzMwMSRnMSR0MTc2MDU5NzA0MSRqNTckbDAkaDE5OTY1ODc1OTc.) [![Install in Cursor](https://img.shields.io/badge/Cursor-Install_Server-black?style=flat-square&logo=cursor&logoColor=white)](https://gitkraken.dev/deeplink?product=gitlens&path=/link/command/install-mcp&ide=cursor&__hstc=91416005.36b7b55e451d23c79de91bbf539cbdd9.1710276073503.1760514722070.1760597038071.206&__hssc=91416005.2.1760597038071&__hsfp=2819208119&_gl=1*16g2pxj*_gcl_au*Njc0MDYxMzMzLjE3NTkxNzUzMDk.*_ga*MjA4ODE0MDQ0NC4xNzEwOTU1MTc3*_ga_TTGBQHQ5E4*czE3NjA1OTcwMzgkbzMwMSRnMSR0MTc2MDU5NzA0MSRqNTckbDAkaDE5OTY1ODc1OTc.) [![Install in Windsurf](https://img.shields.io/badge/Windsurf-Install_Server-34e8bb?style=flat-square&logo=windsurf&logoColor=white)](https://gitkraken.dev/deeplink?product=gitlens&path=/link/command/install-mcp&ide=windsurf&__hstc=91416005.36b7b55e451d23c79de91bbf539cbdd9.1710276073503.1760514722070.1760597038071.206&__hssc=91416005.2.1760597038071&__hsfp=2819208119&_gl=1*p414s6*_gcl_au*Njc0MDYxMzMzLjE3NTkxNzUzMDk.*_ga*MjA4ODE0MDQ0NC4xNzEwOTU1MTc3*_ga_TTGBQHQ5E4*czE3NjA1OTcwMzgkbzMwMSRnMSR0MTc2MDU5NzA0MSRqNTckbDAkaDE5OTY1ODc1OTc.) [![Install in Trae](https://img.shields.io/badge/Trae-Install_Server-32f08c?style=flat-square&logo=trae&logoColor=white)](https://gitkraken.dev/deeplink?product=gitlens&path=/link/command/install-mcp&ide=trae&__hstc=91416005.36b7b55e451d23c79de91bbf539cbdd9.1710276073503.1760514722070.1760597038071.206&__hssc=91416005.2.1760597038071&__hsfp=2819208119&_gl=1*khjtg5*_gcl_au*Njc0MDYxMzMzLjE3NTkxNzUzMDk.*_ga*MjA4ODE0MDQ0NC4xNzEwOTU1MTc3*_ga_TTGBQHQ5E4*czE3NjA1OTcwMzgkbzMwMSRnMSR0MTc2MDU5NzA0MSRqNTckbDAkaDE5OTY1ODc1OTc.)

## 安装

GitKraken MCP 服务器的安装有几种方法,这取决于您想要使用它的环境.

### 用 GitLens 在 VS 代码中安装

如果您正在使用一个足够新版本的 VS 代码并安装了 GitLens, MCP 服务器将自动安装给您 。 为了验证这一点,你只需要运行一个将使用我们的MCP服务器的副驾驶提示. 例如,您可以运行以下提示:

> 交给我的问题是什么?

### 在其它带有 GitLens 的IDE 安装

GitLens可以将其自动安装在基于其他VS代码的IDE中,如Cursor,WindSurf,Trae,和Kiro.

为快速安装,请使用上面的一击安装按钮之一. 完成该流后,切换代理模式(由 Copilot Chat 文本输入定位)和服务器会启动.

如果您已经拥有了 Gitlens, 您可以简单地将命令调色板( Ctrl+Shift+P) 调色板( Ctrl+Shift+P) 并输入“ GitLens: 安放 MCP 服务器 ” , 并选择在您的 IDE 中安装 MCP 服务器的选项 .

更多关于使用 VS 代码中的 MCP 服务器工具 [代理模式文档](https://code.visualstudio.com/docs/copilot/chat/mcp-servers)。 。 。 .

### 没有 GitLens 安装

为方便安装, 您可以使用 GitKraken CLI 命令 :

```bash
gk mcp install <PLATFORM>
```

或者,你可以手动在您的 IDE 的 MCP 设置中添加以下 JSON 块 :

```json
{
  "mcp": {
    "servers": {
      "gitkraken": {
        "command": "gk",
        "args": ["mcp"],
        "type": "stdio"
      }
    }
  }
}
```

这假设你在全球运行了安装命令(`npm i -g @gitkraken/gk`) (中文(简体) ).

在可选情况下,您可以在名为 mcp 的文件中添加类似的例子( 即没有 mcp 密钥) `.vs code/mcp.json` 在你的工作空间。 这将允许您与接受同样格式的其他主机应用程序共享配置 .

更多关于使用 [GitKraken MCP 文档](https://help.gitkraken.com/mcp/mcp-getting-started/)

## 工具

### Git 工具

| 工具集 | 说明 |
| --- | --- |
| `git_add` | 将文件内容添加到索引( git 添加< pathspec>) . |
| `git_blame` | 显示文件的修改内容和作者最后修改的每行( git buge <file>) . |
| `git_branch` | 列出或创建分支( git 分支) . |
| `git_checkout` | 切换分支或恢复工作树文件( git checkout <branch>). |
| `git_commit` | 记录寄存器的更改( git 承诺 - m <message> \[文件.\]). |
| `git_log_or_diff` | 显示承诺日志或承诺之间的更改( git log -- oneline 或 git diff) . |
| `git_push` | 与相关对象一起更新远程 refs( git push). |
| `git_stash` | 在肮脏的工作目录( git switch)中记录变化 . |
| `git_status` | 显示工作树状态( git 状态) . |
| `git_worktree` | 列出或添加 git 工作树( git 工作树 <action>) . |

### 拉动请求工具

| 工具集 | 说明 |
| --- | --- |
| `pull_request_assigned_to_me` | 在您是作者或受让人的地方搜索拉动请求(可选择包括请求的通过 `reviewer`(中文(简体) ) |
| `pull_request_create` | 创建一个新的拉取请求 。 支持可选 `assign_to_me`; GitHub 和 GitLab 将 PR 指派给当前用户, Azure DevOps 和 Bitbucket 则返回提供者不支持的警告 `assign_to_me`。 。 。 . |
| `pull_request_create_review` | 为拉动请求创建审查 |
| `pull_request_get_comments` | 在拉动请求中获取所有评论 |
| `pull_request_get_detail` | 获取一个特定的拉动请求 |
| `repository_get_file_content` | 从仓库获取文件内容 |

### 问题工具

| 工具集 | 说明 |
| --- | --- |
| `issues_add_comment` | 对一个问题添加评论 |
| `issues_assigned_to_me` | 获取指定给用户的问题 |
| `issues_create` | 创建新问题 |
| `issues_get_detail` | 使用其独特的身份证检索关于某一具体问题的详细资料 |

### GitKraken 工具

| 工具集 | 说明 |
| --- | --- |
| `gitkraken_workspace_list` | 列出全部 GitKraken 工作空间 |

## 提示

-   **代码 审查 分支** - 根据提供的上下文生成代码审查分支名称.
    -   分支 名称: 要审查的分支名称( 需要)

## 常见问题

### @gitkraken/gk 是什么？

gk是命令线上的GitKraken\. 它使跨多个重置功能与Workspace更容易工作,提供了从多个服务\(GitHub,GitLab,Bitbucket等\)中调取请求和问题的访问权限,并与GitKraken客户端和Git无缝连接

### 如何安装 @gitkraken/gk？

在项目目录运行 npm install @gitkraken/gk，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 gk，可以用 npx gk 直接运行。

### @gitkraken/gk 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/gitkraken\_\_gk 是否存在。

### @gitkraken/gk 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @gitkraken/gk 可以商用吗？

@gitkraken/gk 使用 CC-BY-3\.0-US 许可。声明的许可为 CC-BY-3\.0-US，请阅读许可原文确认使用条件。以上为概括，不构成法律意见，请以许可原文为准。

### @gitkraken/gk 的下载量有多少？

根据 npm 官方下载统计，@gitkraken/gk 在 2026/10/17 – 2026/11/15 这 30 天内被下载 319,809 次，日均约 10,660 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @gitkraken/gk 还在维护吗？

最新版本 3\.1\.77 发布于 2026/10/14（1 个月前）；至今共发布 22 个版本，其中过去 12 个月发布了 17 个；首次发布于 2025/10/17。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

