@gitbook/cli

中文文档
0.33.1发布于 2026/11/12构建来源已验证近 30 天下载 2.9万

CLI to build and publish integrations on GitBook.com

原始使用文档
文档目录3 节
  1. Step 1: Install the GitBook CLI
  2. Step 2: Authenticate with your account
  3. Step 3: Bootstrap your app

@gitbook/cli

Step 1: Install the GitBook CLI

The GitBook Development CLI requires Node v18 or later. It can be installed from NPM using:

npm install @gitbook/cli -g

Step 2: Authenticate with your account

The quickest way to sign in is through your browser:

gitbook login

This opens GitBook in your browser, asks you to authorize the CLI, and stores the resulting token locally. Sessions are refreshed automatically.

Alternatively, authenticate with a personal API token. Create one at app.gitbook.com/account/developer, then run:

gitbook auth --token <token>

Note: Publishing integrations (gitbook integration publish / unpublish) requires a personal API token — the browser (OAuth) session cannot perform those operations. Use gitbook auth for publishing workflows.

To sign out, run gitbook logout.

Step 3: Bootstrap your app

Bootstrap your first app by running:

gitbook integration new

版本与发布记录

@gitbook/cli 共发布 67 个版本,首次发布于 2022/06/06;过去 12 个月发布了 28 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.33.1latest2026/11/123 天前
0.33.02026/11/105 天前
0.32.122026/10/2917 天前
0.32.112026/10/2918 天前
0.32.102026/10/131 个月前
0.32.92026/10/071 个月前

关于 @gitbook/cli 的常见问题

@gitbook/cli 是什么?

CLI to build and publish integrations on GitBook.com

如何安装 @gitbook/cli?

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

@gitbook/cli 支持 TypeScript 吗?

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

@gitbook/cli 需要什么版本的 Node.js?

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

@gitbook/cli 可以商用吗?

@gitbook/cli 使用 未声明 许可。package.json 没有声明许可证。没有许可证的代码默认保留全部权利,商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括,不构成法律意见,请以许可原文为准。

@gitbook/cli 的下载量有多少?

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

@gitbook/cli 还在维护吗?

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