# bitfab-cli 中文文档

规范地址：https://npmcn.com/package/bitfab-cli/

版本：0\.2\.512
npm 元数据更新时间：2026-11-03T04:01:49.621Z
中文译文更新时间：2026-11-03T06:12:25.999Z
软件包许可：MIT

本文由上游 README 机器翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/bitfab-cli
原文对照：https://npmcn.com/package/bitfab-cli/?lang=original
项目主页：https://bitfab.ai/
源码仓库：https://github.com/Project-White-Rabbit/ai-assistant

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：2.1 MB，3 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=18\.0\.0
- 运行依赖：2 个
- 首次发布：2026-05-13T16:55:37.049Z
- 最新版本发布：2026-11-03T04:01:49.419Z
- 已发布版本数：504（近 12 个月 504 个）

## 中文简介

在Claude Code， Codex或Cursor中安装和配置Bitfab插件，或在Amp （Alpha）中安装和配置Bitfab技能包。

## 安装

```sh
npm install bitfab-cli
```

也可以使用：`pnpm add bitfab-cli`、`yarn add bitfab-cli`、`bun add bitfab-cli`

## README

# bitfab-cli

在Claude Code， Codex， Cursor或Amp中安装和配置Bitfab插件。

## 使用

```bash
npx bitfab-cli init                       # Detect editors, prompt if multiple
npx bitfab-cli init --editor claude       # Install for Claude Code
npx bitfab-cli init --editor codex        # Install for Codex
npx bitfab-cli init --editor cursor       # Install for Cursor
npx bitfab-cli init --editor amp          # Install for Amp
npx bitfab-cli init --prompt "instrument the chat workflow"
npx bitfab-cli init --v2                    # Login + setup entirely in this terminal
npx bitfab-cli setup --v2 instrument        # Run one setup mode in this terminal
npx bitfab-cli setup --v2 --diagram         # Print the declarative Mermaid state diagram
npx bitfab-cli setup --prompt "modify the billing trace"
npx bitfab-cli session-logs enable        # Enable session log collection
npx bitfab-cli session-logs disable       # Disable session log collection
npx bitfab-cli session-logs status        # Show the saved session log setting
npx bitfab-cli analyze-repo --help        # Show help for analyze-repo
npx bitfab-cli help setup                 # Show help for setup
```

## Terminal-native设置

`init --v2` 和 `setup --v2` 通过Claude Agent SDK在终端中运行声明式设置流。安装程序读取选定的工作流，并直接写入工具及其重放注册表。登录即可打开浏览器。模板编辑留在终端中。代理请求丢失的选项或所需的重构，并遵循终端的工具权限。

集 `ANTHROPIC_API_KEY`，或在使用前配置Agent SDK支持的云提供商之一 `--v2`． Bitfab身份验证是独立的： `init --v2` 需要时打开浏览器进行登录，然后返回到终端。

`setup --v2` 接受 `wizard`， `explain`， `login`， `session-logs`， `instrument`， `modify`， `inspect`， `switch-org`， `view`， `replay`， `db-snapshot`， `templates`，或者 `analyze-repo`． 添加 `--diagram` 使用任何模式来检查确切的状态图，而无需身份验证或启动代理。

## Amp

`--editor amp` 克隆的 [Bitfab放大器插件](https://github.com/Project-White-Rabbit/bitfab-amp-plugin) 成 `~/.config/amp/plugins/bitfab`确认安培装载了 `amp plugins list`，然后启动Amp并打印要调用的技能。`bitfab:setup`， `bitfab:update sdk`)，因为Amp在发布时不会接收初始消息。 `analyze-repo --editor amp` 无头穿过 `amp -x`. `--skip-permissions` 没有安培发射旗；命令行指向 `amp.dangerouslyAllowAll` 设置。

## 常见问题

### bitfab-cli 是什么？

在Claude Code， Codex或Cursor中安装和配置Bitfab插件，或在Amp （Alpha）中安装和配置Bitfab技能包。

### 如何安装 bitfab-cli？

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

### bitfab-cli 支持 TypeScript 吗？

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

### bitfab-cli 支持 ESM 还是 CommonJS？

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

### bitfab-cli 需要什么版本的 Node\.js？

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

### bitfab-cli 可以商用吗？

bitfab-cli 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### bitfab-cli 还在维护吗？

最新版本 0\.2\.512 发布于 2026/11/03（今天）；至今共发布 504 个版本，其中过去 12 个月发布了 504 个；首次发布于 2026/05/14。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。