@coryparry/codekeeper

中文文档
0.5.3发布于 2026/08/25Apache-2.0ES Module构建来源已验证近 30 天下载 4406

Repository-owned AI maintainer for GitHub Actions, with pull request review, issue triage, audits, and verified repairs

原始使用文档
文档目录8 节
  1. Install
  2. What the installer writes
  3. GitHub App and secrets
  4. CLI
  5. Supported surface
  6. Documentation
  7. Security
  8. License

Codekeeper

Codekeeper is a guided CLI that installs an always-available maintainer in a GitHub.com repository. It reviews pull requests, triages issues, audits repository health, and can prepare small, verified repairs from GitHub Actions you own.

You do not write the workflows by hand. The CLI helps you choose models, capabilities, validation commands, and GitHub App permissions, then opens a setup pull request for you to review. It never merges that pull request.

Requires Node.js 22 or newer, Git, an authenticated GitHub CLI, and permission to administer the target repository.

Install

From a clean checkout of the repository's default branch:

npx @coryparry/[email protected] init

The installer:

  1. checks Node, Git, GitHub CLI authentication, admin access, and checkout state;
  2. lets you choose Recommended (automatic PR review and manual maintenance) or Customize;
  3. helps you create an adopter-owned GitHub App with the required permissions;
  4. uploads provider credentials and the App private key to GitHub secrets; and
  5. opens a setup pull request. It does not merge it.

After you merge that pull request, from a clean checkout of the default branch:

npx @coryparry/[email protected] verify

Open one small same-repository pull request and confirm the App-authored review before you make the review gate required.

What the installer writes

Selected workflows determine the exact set. A Recommended install typically includes:

  • .github/codekeeper.json — policy, models, and safety boundaries
  • .github/codekeeper-release.json — installed package identity and receipt
  • .github/codekeeper/README.md — ownership of installed files
  • .github/codekeeper/actions/acquire-package/action.yml — exact package fetch
  • .github/workflows/codekeeper.yml — one static caller for every installed mode
  • .github/workflows/codekeeper-runtime.yml — shared compute, validate, publish, and credential-proof jobs

Optional .github/codekeeper/agents/*.md files override packaged agent profiles after they merge to the default branch.

GitHub App and secrets

The installer creates or updates repository secrets and variables. It does not print their values.

Typical names:

NameKindPurpose
CODEKEEPER_ENABLEDvariableStartup switch; set last
CODEKEEPER_APP_CLIENT_IDvariableGitHub App client ID
CODEKEEPER_AUTOMATION_BOT_LOGINvariableTrusted App bot login
CODEKEEPER_APP_PRIVATE_KEYsecretApp PEM
OPENAI_API_KEYsecretOpenAI model calls when selected
DEEPSEEK_API_KEYsecretDeepSeek when selected
OPENROUTER_API_KEYsecretOpenRouter when selected
OPENAI_TRACE_API_KEYsecretOptional tracing; do not reuse the model key

Install the App only on the selected repository. Do not paste the PEM into the terminal; choose the downloaded file in the installer.

CLI

npx @coryparry/[email protected] init
npx @coryparry/[email protected] update
npx @coryparry/[email protected] update --to X.Y.Z
npx @coryparry/[email protected] update --check
npx @coryparry/[email protected] rollback --to X.Y.Z
npx @coryparry/[email protected] doctor [--json]
npx @coryparry/[email protected] verify [--json] [--controlled]

init also reopens guided settings for an existing installation. update moves to a newer verified release. rollback --to asks that older release to open a normal update pull request; it never force-pushes.

To pack this source checkout into a local tarball instead of using npm, see INSTALL.md.

Supported surface

  • GitHub.com repositories. GitHub Enterprise Server is not supported.
  • Review: same-repository, non-draft pull requests.
  • Automatic repair and automatic merge stay limited to the configured default branch.
  • Forks, drafts, and merge queues are outside the supported surface.
  • Installed runtimes use ephemeral GitHub-hosted Ubuntu runners. Persistent shared self-hosted runners are unsupported.
  • Code-changing capabilities need a deterministic repository validation command beyond git diff --check.

Recommended starts with repair, issue implementation, duplicate closure, scheduled maintenance, tracing, and automatic merge off.

Documentation

The installer records the exact Git commit of a package build in generated asset metadata. Do not hand-edit that commit.

Security

Do not commit provider keys, GitHub App private keys, tokens, or live traces. Report vulnerabilities through GitHub private vulnerability reporting as described in SECURITY.md.

License

Apache-2.0. See LICENSE.

版本与发布记录

@coryparry/codekeeper 共发布 25 个版本,首次发布于 2026/08/21;过去 12 个月发布了 25 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.5.3latest2026/08/252 个月前
0.5.22026/08/252 个月前
0.5.12026/08/242 个月前
0.5.02026/08/232 个月前
0.4.102026/08/232 个月前
0.4.92026/08/232 个月前

其他发布通道:bootstrap → 0.0.0-security。

关于 @coryparry/codekeeper 的常见问题

@coryparry/codekeeper 是什么?

Repository-owned AI maintainer for GitHub Actions, with pull request review, issue triage, audits, and verified repairs

如何安装 @coryparry/codekeeper?

在项目目录运行 npm install @coryparry/codekeeper,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 codekeeper、codekeeper-verify-package,可以用 npx codekeeper 直接运行。

@coryparry/codekeeper 支持 TypeScript 吗?

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

@coryparry/codekeeper 支持 ESM 还是 CommonJS?

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

@coryparry/codekeeper 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@coryparry/codekeeper 可以商用吗?

@coryparry/codekeeper 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@coryparry/codekeeper 的下载量有多少?

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

@coryparry/codekeeper 还在维护吗?

最新版本 0.5.3 发布于 2026/08/25(2 个月前);至今共发布 25 个版本,其中过去 12 个月发布了 25 个;首次发布于 2026/08/21。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。