# @corsair-dev/github 中文文档

规范地址：https://npmcn.com/package/%40corsair-dev/github/

版本：0\.1\.20
npm 元数据更新时间：2026-11-06T10:57:32.871Z
中文译文更新时间：2026-11-10T19:41:46.405Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：3.4 MB，104 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：zod ^4\.1\.13，corsair \>=0\.1\.0
- 首次发布：2026-04-04T03:44:20.096Z
- 最新版本发布：2026-11-06T10:57:32.673Z
- 近 30 天下载量：11958（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：21（近 12 个月 21 个）

## 中文简介

Corsair 的 Github 插件

## 安装

```sh
npm install @corsair-dev/github
```

也可以使用：`pnpm add @corsair-dev/github`、`yarn add @corsair-dev/github`、`bun add @corsair-dev/github`

## README

# @corsair-dev/github (英语)

Corsair 的 Github 插件 .

## 安装

```bash
pnpm add @corsair-dev/github
```

## 终点

| 运行 | 操作标识 | 风险 | 说明 |
| --- | --- | --- | --- |
| `comments.delete` | `github.api.comments.delete` | `write` | 删除注释 |
| `comments.get` | `github.api.comments.get` | `read` | 获取具体评论 |
| `comments.list` | `github.api.comments.list` | `read` | 在仓库中列出所有注释 |
| `comments.listForIssue` | `github.api.comments.listForIssue` | `read` | 清单对具体问题或拉动请求的评论 |
| `comments.update` | `github.api.comments.update` | `write` | 更新评论 |
| `discussions.get` | `github.api.discussions.get` | `read` | 具体讨论一下 |
| `discussions.list` | `github.api.discussions.list` | `read` | 在存储库中列出讨论情况 |
| `events.list` | `github.api.events.list` | `read` | 列出公开的 GitHub 事件 |
| `events.listForNetwork` | `github.api.events.listForNetwork` | `read` | 列出存储器网络的公共事件 |
| `events.listForOrg` | `github.api.events.listForOrg` | `read` | 列出一个组织的公开活动 |
| `events.listForRepository` | `github.api.events.listForRepository` | `read` | 列出仓库事件 |
| `events.listForUser` | `github.api.events.listForUser` | `read` | 为用户列出事件 |
| `events.listForUserOrg` | `github.api.events.listForUserOrg` | `read` | 列出用户的组织活动 |
| `events.listPublicForUser` | `github.api.events.listPublicForUser` | `read` | 列出用户的公共事件 |
| `events.listPublicReceivedForUser` | `github.api.events.listPublicReceivedForUser` | `read` | 列出用户收到的公共事件 |
| `events.listReceivedForUser` | `github.api.events.listReceivedForUser` | `read` | 列出用户收到的事件 |
| `forks.list` | `github.api.forks.list` | `read` | 列出仓库的叉 |
| `issues.create` | `github.api.issues.create` | `write` | 创建新问题 |
| `issues.createComment` | `github.api.issues.createComment` | `write` | 就一个问题发表评论 |
| `issues.get` | `github.api.issues.get` | `read` | 问个问题 |
| `issues.list` | `github.api.issues.list` | `read` | 在存储处列出问题 |
| `issues.update` | `github.api.issues.update` | `write` | 更新现有问题 |
| `pullRequests.createReview` | `github.api.pullRequests.createReview` | `write` | 提交拉动请求审查 |
| `pullRequests.get` | `github.api.pullRequests.get` | `read` | 获取一个特定的拉动请求 |
| `pullRequests.list` | `github.api.pullRequests.list` | `read` | 列表拉动请求 |
| `pullRequests.listReviews` | `github.api.pullRequests.listReviews` | `read` | 清单对拉动请求的审查 |
| `releases.create` | `github.api.releases.create` | `write` | 创建新发行 |
| `releases.get` | `github.api.releases.get` | `read` | 获取一个特定的发布 |
| `releases.list` | `github.api.releases.list` | `read` | 在仓库中列出发布 |
| `releases.update` | `github.api.releases.update` | `write` | 更新已有的发布 |
| `repositories.checkStarred` | `github.api.repositories.checkStarred` | `read` | 检查已认证的用户是否主控了寄存器 |
| `repositories.get` | `github.api.repositories.get` | `read` | 获取特定寄存器 |
| `repositories.getContent` | `github.api.repositories.getContent` | `read` | 从仓库获取文件或目录内容 |
| `repositories.list` | `github.api.repositories.list` | `read` | 为经认证的用户列表寄存器 |
| `repositories.listBranches` | `github.api.repositories.listBranches` | `read` | 在仓库中列出分支 |
| `repositories.listCommits` | `github.api.repositories.listCommits` | `read` | 在仓库中执行列表 |
| `repositories.listStargazers` | `github.api.repositories.listStargazers` | `read` | 列出主控仓库的用户 |
| `repositories.listStarred` | `github.api.repositories.listStarred` | `read` | 列表寄存器, 由认证的用户主控 |
| `repositories.star` | `github.api.repositories.star` | `write` | 为认证的用户设置一个仓库 |
| `repositories.unstar` | `github.api.repositories.unstar` | `write` | 为认证的用户解开存储器 |
| `search.issues` | `github.api.search.issues` | `read` | 搜索 GitHub 问题并拉动请求 |
| `search.repositories` | `github.api.search.repositories` | `read` | 搜索 GitHub 仓库 |
| `search.users` | `github.api.search.users` | `read` | 搜索 GitHub 用户和组织 |
| `users.get` | `github.api.users.get` | `read` | 按用户名获取用户 |
| `users.getAuthenticated` | `github.api.users.getAuthenticated` | `read` | 获取认证用户 |
| `users.getById` | `github.api.users.getById` | `read` | 通过账户ID获取用户 |
| `users.getHovercard` | `github.api.users.getHovercard` | `read` | 为用户获取上下文的徘徊卡信息 |
| `users.list` | `github.api.users.list` | `read` | 列出所有 GitHub 用户 |
| `users.update` | `github.api.users.update` | `write` | 更新认证的用户配置 |
| `workflows.get` | `github.api.workflows.get` | `read` | 获得特定的工作流程 |
| `workflows.list` | `github.api.workflows.list` | `read` | 在仓库中列出工作流程 |
| `workflows.listRuns` | `github.api.workflows.listRuns` | `read` | 列表工作流程运行 |

## 认证

Auth: API密钥, OAuth 2. 0, 管理 OAuth(默认 API密钥). 设定 `authType` 在插件厂选择一个.

## 网络呼号

处理100个网游事件. 见有效载荷和 `webhookHooks`。 。 。 .

## 参考文献

完整文件、类型和示例: [https://docs.corsair.dev/plugins/github (英语)](https://docs.corsair.dev/plugins/github)

## 许可证

阿帕奇 - 2.0

## 常见问题

### @corsair-dev/github 是什么？

Corsair 的 Github 插件

### 如何安装 @corsair-dev/github？

在项目目录运行 npm install @corsair-dev/github，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：zod（^4\.1\.13）、corsair（\>=0\.1\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @corsair-dev/github 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @corsair-dev/github 支持 ESM 还是 CommonJS？

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

### @corsair-dev/github 可以商用吗？

@corsair-dev/github 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @corsair-dev/github 的下载量有多少？

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

### @corsair-dev/github 还在维护吗？

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