gitdog

中文文档
0.2.1发布于 2026/11/04UNLICENSEDES Module构建来源已验证

Manage Gitdog projects, GitHub automation and API keys from your terminal

原始使用文档
文档目录4 节
  1. Run with npx
  2. Quick start
  3. Everyday commands
  4. Use in CI

Gitdog

Gitdog CLI

Your GitHub assistant. Now in the terminal.

npm version CI npm release Node.js 22.14 or later Gitdog website

Gitdog terminal: connect a project, configure automation and review pending actions

Connect repositories, configure issue, discussion and PR automation, review AI actions, and manage project tasks from your terminal or CI.

Run with npx

Requires Node.js 22.14+. No global installation needed.

npx gitdog@latest --help

Quick start

npx gitdog@latest login
npx gitdog@latest github install
npx gitdog@latest github recover
npx gitdog@latest init owner/repo
npx gitdog@latest config set requireApproval true
npx gitdog@latest config set pullRequestReviewsEnabled true
npx gitdog@latest config set requireApprovalForPullRequests true
npx gitdog@latest config push

GitHub App setup is only needed once. A project connects an existing GitHub repository to Gitdog.

Everyday commands

TaskCommand
List projectsnpx gitdog@latest projects list
Read automation settingsnpx gitdog@latest config get --remote
Review pending actionsnpx gitdog@latest tickets pending
Check code indexingnpx gitdog@latest index status
List team membersnpx gitdog@latest team members
Check usagenpx gitdog@latest usage summary

Use npx gitdog@latest --help to explore commands. Add --json for scripts.

Use in CI

npx gitdog@latest keys create --name ci
npx --yes [email protected] --key-file /path/to/key.json projects list --json
npx gitdog@latest keys revoke KEY_ID --yes

keys create prints the private key file's path. Keys are project-scoped and read-only by default; add --write for settings and ticket delete/restore. Keep key files out of Git.


Command reference · Gitdog · Report an issue

版本与发布记录

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

版本发布日期距今
0.2.1latest2026/11/04今天
0.2.02026/11/03今天
0.1.22026/11/03今天
0.1.12026/11/03今天
0.1.02026/11/03今天
0.0.0-stage2026/11/03今天

关于 gitdog 的常见问题

gitdog 是什么?

从您的终端管理git项目,GitHub自动化和API密钥

如何安装 gitdog?

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

gitdog 支持 TypeScript 吗?

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

gitdog 支持 ESM 还是 CommonJS?

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

gitdog 需要什么版本的 Node.js?

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

gitdog 可以商用吗?

gitdog 使用 UNLICENSED 许可。作者声明为 UNLICENSED,即不授予公开使用许可(与公共领域的 Unlicense 不同)。使用前需获得作者授权。以上为概括,不构成法律意见,请以许可原文为准。

gitdog 还在维护吗?

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