# @fairmint/captable-ai 中文文档

规范地址：https://npmcn.com/package/%40fairmint/captable-ai/

版本：0\.1\.42
npm 元数据更新时间：2026-11-10T21:28:54.830Z
中文译文更新时间：2026-11-14T09:35:26.206Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40fairmint/captable-ai
原文对照：https://npmcn.com/package/%40fairmint/captable-ai/?lang=original
项目主页：https://captable.ai/
源码仓库：https://github.com/fairmint/apiv2

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

- 包体积（解压后）：954 kB，4 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=20
- 运行依赖：0 个
- 首次发布：2026-06-24T22:12:25.929Z
- 最新版本发布：2026-11-10T21:28:54.663Z
- 近 30 天下载量：2426（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：44（近 12 个月 44 个）

## 中文简介

Captable AI的代理本地CLI——管理公司,上传文件,运行OCF提取,以及从终端承诺封顶表.

## 安装

```sh
npm install @fairmint/captable-ai
```

也可以使用：`pnpm add @fairmint/captable-ai`、`yarn add @fairmint/captable-ai`、`bun add @fairmint/captable-ai`

## README

# @ fairmint/ captable-ai (中文(简体) )

代理本地命令行接口 [能力AI](https://captable.ai/)管理 公司,上传文档,运行 OCF( Open Cap Format) 提取,审查和编辑 提取对象,并承诺封顶表——全部来自您的终端或AI代理.

为人类和AI特工建造:每个命令都支持 `--json` 为结构化, 可解析输出,使用稳定的退出代码分类法,并拒绝使用未知的旗帜 有帮助的错误.

## 安装

```bash
npm install -g @fairmint/captable-ai
```

这暴露出两个二进制: `captable-ai` 和简称 `cai`。需要节点.js QQ 20.

## 认证

```bash
captable-ai login
```

打开浏览器进行认证。 批准后,单击“浏览器中的完成”或粘贴 登录代码返回终端。 全权证书存于 `~/.captable-ai/`启用 `captable-ai logout` 以清除他们 `captable-ai auth status` 检查会话.

## 快速启动

```bash
captable-ai login
captable-ai onboarding status
captable-ai onboarding setup ...            # only when you have no workspace
captable-ai company use "Acme Inc"           # if you have more than one
captable-ai import start
captable-ai documents upload ./docs/*.pdf
captable-ai import status <session-id>
captable-ai documents trigger-extraction    # once all docs are CLASSIFIED
captable-ai documents list                  # poll until PROCESSED
captable-ai commit --dry-run                 # preview
captable-ai commit --all                     # commit all drafts (or --objects id1,id2)
captable-ai summary
```

## 上传文档——最佳流程

CaptablyAI通过阅读您的法律文件来构建您的封面表. 输油管是 自动化,但一些习惯使提取速度更快,更准确:

1.  **先上传一切.** 将您所有的封面表格文件添加到前面, 在一个 可能情况下的批次——公司注册、登记、储存和期权协议、董事会 同意的话 支持:PDF,DOCX,XLSX,DOC,和图像,每个文件通过CLI最多可有50MB. `captable-ai documents upload ./docs/*.pdf`
2.  **等分类.** 每个文件都是OCR'd和分类的(类型+有效) (日期)。 在文件显示前不要触发提取 `CLASSIFIED`。 。 。 . `captable-ai documents list`
3.  **检查分类日期.** 分类期间确定的生效日期 确定处理顺序。 触发提取前修补错误的日期 : `captable-ai documents classification-update`
4.  **触发提取一次.** 提取是 **没有** cLI 自动启动 上传——在所有文件被分类后一次性运行. `captable-ai documents trigger-extraction`
5.  **让 FIFO 队列运行 .** 文档按升序一次取出一个 因此,后来的事件建立在更早的事件之上. 每份文件需要几分钟.
6.  **验证自动运行 .** 最后一个文档完成提取后, a 全公司验证员横跨所有对象修复交叉文件问题——否 需要采取行动.
7.  **复议,然后承诺.** 当所有文档到达时 `PROCESSED`,审查和承诺. `captable-ai objects list --status draft` → `captable-ai commit --dry-run` → `captable-ai commit --all` (承诺要求 `--all` 或者说 `--objects id1,id2,...`) (中文(简体) ).

**耐心点,什么时候再试:**

-   提取和验证是同步的。 票价 `captable-ai documents list` (或 `captable-ai documents processing-status`而不是重新触发——重复 触发器只是慢事情下来.
-   每个文件取出和校验器只考虑在大致后卡住 **15个 分钟** 没有进展。 在窗外等着,否则会出问题.
-   重试命令是最后的手段,仅在等待窗口之后使用 : `documents reprocess` 联合国 `FAILED` 医生, `documents cancel-extraction` 编号 : `documents restart-extraction` 联合国 真正被卡住的医生),或 `retrigger-validation` (一个停滞的验证器).

## 图标

| 命令 | 说明 |
| --- | --- |
| `login` 编号 : `logout` | 认证/ 清除存储的证书 |
| `auth status` | 显示当前会话 |
| `onboarding status|setup` | 检查或创建第一个工作空间 |
| `import start|status` | 开始导入会话并对现有文档处理进行投票 |
| `company list|use|current|create|delete` | 管理和选择活动的公司 |
| `documents upload|list|download|delete` | 管理源文档 |
| `documents trigger-extraction|cancel-extraction|restart-extraction|reprocess` | 控制OCF提取管道 |
| `documents processing-status|classification-types|classification-update` | 检查文件状态/ 分类 |
| `agreements list|download` | 签署的投资和赠款协议,一小时的下载链接 |
| `objects list|get|dump|update|patch|revert|versions|delete` | 处理提取的 OCF 对象(`list` 支持 `--document`, (中文(简体) ), `--stakeholder`, (中文(简体) ), `--all`, (中文(简体) ), `--max-confidence`· ; `dump` 写入引擎形状 `ocf.json`(中文(简体) ) |
| `schemas list|get` | 浏览 OCF 对象类型注册 |
| `commit` | 将草稿提交封面表 -- `--all` 或者说 `--objects id1,id2` (单位:千美元)`--dry-run` 预览) |
| `summary` | 完整封顶表快照 |
| `export` 编号 : `register` | 导出封顶表 (Excel) / 股东登记册 (`--include-equity-awards` 增加选项赠款) |
| `export stock|grants|warrants|convertibles` | A. 一个仪器登记簿,每个担保一行(默认的Excel链接); `--csv` 编号 : `--json` 用于行) |
| `pro-forma run` | 融资模式、可兑换货币、授权书和选择权组合方案 |
| `retrigger-validation` | 重新排队一个已停顿的验证符 |
| `jobs list|get|prune` | 跟踪同步操作 |
| `profile save|use|list|get|delete` | 命名的配置配置配置 |
| `logs` | 查看代理/提取日志 |
| `feedback` | 向维护者报告 CLI 摩擦 |
| `commands` | 所有命令和旗帜的机器可读列表 |

运行 `captable-ai <command> --help` 完全使用,或 `captable-ai commands --json` 联 合 国 权威机器可读列表.

## 已签署的协定

`documents list` 持有什么 提取管道摄入。 已签署的协定 无论是否摄入,分别列出:

```bash
captable-ai agreements list                      # investments and grants, newest signed first
captable-ai agreements list --type grant --json
captable-ai agreements download grant:<awardId>  # one-hour download link
```

-   **投资** ——一个SAFE(发送一款SAFE,社区SAFE)的签名文件自定义 文档,或遗留投资,一旦签署,无论付款是否标明.
-   **赠款** 双方签署一份赠款。 下载是协议, 证明文件,以及两个签名证书。 受赠者的税务表和 83(b) 从未包括选举;从工作室下载.

通过开采管道进口的遗产赠款协议 `documents list` 编号 : `documents download`。 。 。 .

## 仪器登记册

`captable-ai export` 没有登记簿的为完整的法律封面表:多表 Excel 工作簿作为一小时的下载链接返回. 4个登记册输出1个仪器 家庭,每安全一行:

```bash
captable-ai export stock                                   # Excel download link
captable-ai export grants --include-pending                # options, RSUs, other awards
captable-ai export warrants --json                         # rows as a JSON array
captable-ai export convertibles --type SAFE --csv          # SAFEs only, CSV on stdout
captable-ai export convertibles --type NOTE --json --output notes.json
```

每个登记册都带有持有人字段(姓名、电子邮件、地址、国家、国家)和 那个家庭的经济学 赠款以赠款日期为准;可兑换货币署名 日期、执行日期和持有者之后的状况。 没有格式标记,结果就是一个 Excel 工作表 返回为下载链接. `--csv` 打印 RFC-4180 CSV,其标题行为 JSON 键; `--json` 将行打印为 JSON 阵列。 传一或一. `--output <path>` 将 CSV 或 JSON 机构写入文件, 仅就这些命令而言, 并不意味着 `--json`。 。 。 .

默认情况下,一个登记册只列出承诺的上限表. `--include-pending` 添加什么 尚未执行: OCF 对象草稿,加 `investment`, (中文(简体) ), `equity_grant`,以及 `equity_award` (发送一个赠款)没有OCF交易的行. 一行已经 a OCF 对象一次出现。 登记册 只能读,永远不要写草稿。 您必须是活动者的主人或管理者 连队.

## 结构化产出

过 `--json` 转到任何机器可读输出的命令。 数据到Stdout,错误去 至 stderr,并使用输入代码的流程退出 :

| 代码 | 含义 |
| --- | --- |
| 0 个 | 成绩 |
| 2个 | 用法错误( 糟糕/ 未知的旗帜, 缺少参数) |
| 3个 | 需要验证/ 会话已过期 |
| 页:1 | 未找到 |
| 页:1 | 冲突(版本冲突,无所犯) |
| 6个 | 校验错误 |
| 第7条 | 服务器出错( 5xx) |
| 第8条 | 网络错误 |

## 环境变量

| 变量 | 目的 |
| --- | --- |
| `CAPTABLE_AI_STAGE` 编号 : `STAGE` | 目标环境: `production` (违约), `staging`, (中文(简体) ), `dev`, (中文(简体) ), `local` |
| `CAPTABLE_AI_API_URL` | 覆盖 API 基础 URL |
| `CAPTABLE_AI_AUTH_URL` | 覆盖登录页面 URL |
| `CAPTABLE_AI_PORTAL_ID` | 以单一理由取代在业公司 |
| `CAPTABLE_AI_FEEDBACK_URL` | 终点 `feedback send` |

## 许可证

麻省理工学院Fairmint股份有限公司.

## 常见问题

### @fairmint/captable-ai 是什么？

Captable AI的代理本地CLI——管理公司,上传文件,运行OCF提取,以及从终端承诺封顶表\.

### 如何安装 @fairmint/captable-ai？

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

### @fairmint/captable-ai 支持 TypeScript 吗？

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

### @fairmint/captable-ai 支持 ESM 还是 CommonJS？

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

### @fairmint/captable-ai 需要什么版本的 Node\.js？

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

### @fairmint/captable-ai 可以商用吗？

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

### @fairmint/captable-ai 的下载量有多少？

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

### @fairmint/captable-ai 还在维护吗？

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