@corsair-dev/github

中文文档
0.1.20发布于 2026/11/06Apache-2.0TypeScriptES Module零依赖近 30 天下载 1.2万

Corsair 的 Github 插件

中文使用文档
文档目录6 节
  1. 安装
  2. 终点
  3. 认证
  4. 网络呼号
  5. 参考文献
  6. 许可证

@corsair-dev/github (英语)

Corsair 的 Github 插件 .

安装

pnpm add @corsair-dev/github

终点

运行操作标识风险说明
comments.deletegithub.api.comments.deletewrite删除注释
comments.getgithub.api.comments.getread获取具体评论
comments.listgithub.api.comments.listread在仓库中列出所有注释
comments.listForIssuegithub.api.comments.listForIssueread清单对具体问题或拉动请求的评论
comments.updategithub.api.comments.updatewrite更新评论
discussions.getgithub.api.discussions.getread具体讨论一下
discussions.listgithub.api.discussions.listread在存储库中列出讨论情况
events.listgithub.api.events.listread列出公开的 GitHub 事件
events.listForNetworkgithub.api.events.listForNetworkread列出存储器网络的公共事件
events.listForOrggithub.api.events.listForOrgread列出一个组织的公开活动
events.listForRepositorygithub.api.events.listForRepositoryread列出仓库事件
events.listForUsergithub.api.events.listForUserread为用户列出事件
events.listForUserOrggithub.api.events.listForUserOrgread列出用户的组织活动
events.listPublicForUsergithub.api.events.listPublicForUserread列出用户的公共事件
events.listPublicReceivedForUsergithub.api.events.listPublicReceivedForUserread列出用户收到的公共事件
events.listReceivedForUsergithub.api.events.listReceivedForUserread列出用户收到的事件
forks.listgithub.api.forks.listread列出仓库的叉
issues.creategithub.api.issues.createwrite创建新问题
issues.createCommentgithub.api.issues.createCommentwrite就一个问题发表评论
issues.getgithub.api.issues.getread问个问题
issues.listgithub.api.issues.listread在存储处列出问题
issues.updategithub.api.issues.updatewrite更新现有问题
pullRequests.createReviewgithub.api.pullRequests.createReviewwrite提交拉动请求审查
pullRequests.getgithub.api.pullRequests.getread获取一个特定的拉动请求
pullRequests.listgithub.api.pullRequests.listread列表拉动请求
pullRequests.listReviewsgithub.api.pullRequests.listReviewsread清单对拉动请求的审查
releases.creategithub.api.releases.createwrite创建新发行
releases.getgithub.api.releases.getread获取一个特定的发布
releases.listgithub.api.releases.listread在仓库中列出发布
releases.updategithub.api.releases.updatewrite更新已有的发布
repositories.checkStarredgithub.api.repositories.checkStarredread检查已认证的用户是否主控了寄存器
repositories.getgithub.api.repositories.getread获取特定寄存器
repositories.getContentgithub.api.repositories.getContentread从仓库获取文件或目录内容
repositories.listgithub.api.repositories.listread为经认证的用户列表寄存器
repositories.listBranchesgithub.api.repositories.listBranchesread在仓库中列出分支
repositories.listCommitsgithub.api.repositories.listCommitsread在仓库中执行列表
repositories.listStargazersgithub.api.repositories.listStargazersread列出主控仓库的用户
repositories.listStarredgithub.api.repositories.listStarredread列表寄存器, 由认证的用户主控
repositories.stargithub.api.repositories.starwrite为认证的用户设置一个仓库
repositories.unstargithub.api.repositories.unstarwrite为认证的用户解开存储器
search.issuesgithub.api.search.issuesread搜索 GitHub 问题并拉动请求
search.repositoriesgithub.api.search.repositoriesread搜索 GitHub 仓库
search.usersgithub.api.search.usersread搜索 GitHub 用户和组织
users.getgithub.api.users.getread按用户名获取用户
users.getAuthenticatedgithub.api.users.getAuthenticatedread获取认证用户
users.getByIdgithub.api.users.getByIdread通过账户ID获取用户
users.getHovercardgithub.api.users.getHovercardread为用户获取上下文的徘徊卡信息
users.listgithub.api.users.listread列出所有 GitHub 用户
users.updategithub.api.users.updatewrite更新认证的用户配置
workflows.getgithub.api.workflows.getread获得特定的工作流程
workflows.listgithub.api.workflows.listread在仓库中列出工作流程
workflows.listRunsgithub.api.workflows.listRunsread列表工作流程运行

认证

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

网络呼号

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

参考文献

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

许可证

阿帕奇 - 2.0

版本与发布记录

@corsair-dev/github 共发布 21 个版本,首次发布于 2026/04/04;过去 12 个月发布了 21 个版本。

版本发布日期距今
0.1.20latest2026/11/064 天前
0.1.192026/09/102 个月前
0.1.182026/08/212 个月前
0.1.172026/08/212 个月前
0.1.162026/08/192 个月前
0.1.152026/08/053 个月前

关于 @corsair-dev/github 的常见问题

@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 和提交记录判断。