代码管理员
代码管理器是一个向导的CLI,它安装一个总是可用的维护器在一个 GitHub.com 仓库. 它审查拉动请求、三分法问题、审计 从 GitHub 动作中准备经过验证的小型修复 你拥有.
您不会手写工作流程 。 CLI帮助你选择模型, 能力、验证命令和 GitHub App 权限,然后打开一个 设置拉动请求供您审查 。 它从不合并拉动请求.
要求数 22号节点或更新, Git, 一个认证 GitHub 缩写,并允许管理目标 仓库.
安装
从寄存器默认分支的清理取出 :
npx @coryparry/[email protected] init
安装器 :
- 检查节点、 Git、 GitHub CLI 认证、 管理员访问和退出状态;
- 让你选择 建议 (自动PR审查和人工维护) 或者说 自定义· ;
- 帮助您创建一个被收养者拥有的 GitHub App , 并获得所需的权限;
- 上传供应商证书和 App 私密密钥到 GitHub;以及
- 打开一个设置拉动请求。 它不会合并它.
在您合并了拉动请求后, 从默认分支的清理检出 :
npx @coryparry/[email protected] verify
打开一个小的同一存储器拉取请求, 确认 App- authored 在您需要复议门之前进行复议.
安装者写的
选定的工作流程决定确切的集. 通常推荐安装 包括:
.github/codekeeper.json政策、模式和安全界限.github/codekeeper-release.json——已安装的包裹身份和收件.github/codekeeper/README.md——已安装文件的所有权.github/codekeeper/actions/acquire-package/action.yml—— 准确的软件包获取.github/workflows/codekeeper.yml——每个已安装模式都有一个静态呼叫器.github/workflows/codekeeper-runtime.yml——共享计算,验证,发布,以及证明性工作
可选 .github/codekeeper/agents/*.md 文件超过已包装代理
配置文件合并到默认分支后 .
GitHub 应用程序和秘密
安装者创建或更新寄存器的秘密和变量. 没有 打印他们的值.
典型名称 :
| 名称 | 仁爱 | 目的 |
|---|---|---|
CODEKEEPER_ENABLED | 变量 | 启动开关; 最后一个设置 |
CODEKEEPER_APP_CLIENT_ID | 变量 | GitHub App 客户端 ID |
CODEKEEPER_AUTOMATION_BOT_LOGIN | 变量 | 信任的 App 机器人登录 |
CODEKEEPER_APP_PRIVATE_KEY | 隐藏 | App PEM 应用程序 |
OPENAI_API_KEY | 隐藏 | 选中时 OpenAI 模型调用 |
DEEPSEEK_API_KEY | 隐藏 | 选中时深搜索 |
OPENROUTER_API_KEY | 隐藏 | 选中时打开路透器 |
OPENAI_TRACE_API_KEY | 隐藏 | 可选追踪; 不重用模式密钥 |
只在选定的寄存器上安装 App 。 不要粘贴 PEM 到 终端; 选择安装器中下载的文件.
国 际
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 还重新打开用于现有安装的被引导设置. update
移动到更新验证的释放. rollback --to 要求提前释放
打开一个普通的更新拉取请求; 它从不强制-pushes.
要将这个源检出打包到本地的 tarball 而不是使用 npm, 请查看 总部。 。 。 .
支持的表面
- GitHub.com 仓库. GitHub 企业服务器不被支持 .
- 审查:同存,非草案牵引请求.
- 自动修复和自动合并仅限配置的默认 树枝.
- 叉,草稿,和合并队列都在被支持的表面外.
- 已安装的运行时间使用由 GitHub 托管的 Ubuntu 跑道。 持久性 共享的自控跑者不支持.
- 更改代码的能力需要确定仓库验证命令
外加
git diff --check。 。 。 .
建议从修复、执行、重复关闭、, 计划维护、追踪和自动合并 关。 。 。 .
文档
安装者记录生成的软件包构建中的确切 Git 承诺 资产元数据。 不要手动编辑它的承诺.
警卫
不要输入提供者密钥、 GitHub App 私人密钥、 令牌或活的痕迹 . 通过 GitHub 私人脆弱性报告报告脆弱性 说明 警卫。 。 。 .
许可证
阿帕奇2.0 (英语). 见 自由主义。 。 。 .