feishu-bitable-cli

一个面向飞书多维表格的命令行工具，支持通过表格 URL 查询记录、通过记录分享 URL 拉取单条详情、更新记录，以及下载记录附件。

安装

npm install -g @acring/feishu-bitable-cli

安装后可执行命令：

feishu-bitable --help

认证

优先级如下：

1. --access-token
2. 当前 shell 已导出的环境变量
3. 当前工作目录下按顺序加载的环境文件：.env -> .env.local -> .env.<NODE_ENV> -> .env.<NODE_ENV>.local
4. FEISHU_ACCESS_TOKEN
5. LARK_ACCESS_TOKEN
6. FEISHU_USER_ACCESS_TOKEN
7. LARK_USER_ACCESS_TOKEN
8. FEISHU_APP_ID + FEISHU_APP_SECRET
9. LARK_APP_ID + LARK_APP_SECRET

可参考 .env.example。

table-url 也支持通过环境变量提供，优先级如下：

1. 命令行参数中的 table-url
2. 当前 shell / .env* 中的 FEISHU_BITABLE_TABLE_URL
3. LARK_BITABLE_TABLE_URL
4. FEISHU_TABLE_URL
5. LARK_TABLE_URL

用法

查询整张表的记录：

feishu-bitable records "https://xxx.feishu.cn/wiki/xxxx?table=tblxxxx&view=vewxxxx"

查询整张表的字段：

feishu-bitable fields "https://xxx.feishu.cn/wiki/xxxx?table=tblxxxx&view=vewxxxx"

如果已经在环境变量里配置了 table-url，可以直接省略：

export FEISHU_BITABLE_TABLE_URL="https://xxx.feishu.cn/wiki/xxxx?table=tblxxxx&view=vewxxxx"
feishu-bitable records

同样也可以直接查询字段：

feishu-bitable fields

导出单条记录并下载附件：

feishu-bitable record \
  "https://xxx.feishu.cn/wiki/xxxx?table=tblxxxx" \
  "https://xxx.feishu.cn/record/recuXXXXXX" \
  --output ./record-1

配置环境变量后，也可以只传 record-url：

feishu-bitable record \
  "https://xxx.feishu.cn/record/recuXXXXXX" \
  --output ./record-1

更新单条记录：

feishu-bitable update-record \
  "https://xxx.feishu.cn/wiki/xxxx?table=tblxxxx" \
  "recxxxxxxxx" \
  --fields '{"文本":"新的内容","数字":100}'

配置环境变量后，也可以只传 record-id：

feishu-bitable update-record \
  "recxxxxxxxx" \
  --fields '{"文本":"新的内容","数字":100}'

如果字段 JSON 较复杂，也可以从文件读取。文件内容既可以是完整请求体中的 fields 对象，也可以是 { "fields": { ... } }：

feishu-bitable update-record \
  "https://xxx.feishu.cn/wiki/xxxx?table=tblxxxx" \
  "recxxxxxxxx" \
  --fields-file ./fields.json \
  --ignore-consistency-check

开发阶段直接运行 TypeScript 入口：

npm run dev -- --help

发布到 npm

发布前检查：

npm install
npm run pack:check

首次发布 scoped 包建议确认 public access：

npm login
npm publish

当前包已在 package.json 中设置 "publishConfig": { "access": "public" }。