Teamshare CLI

teamshare-cli 是面向 Teamshare 多维表格和审批实例能力的命令行工具。当前定位是：让人工、脚本和 Agent 可以用稳定命令操作 Teamshare，从环境配置、凭证管理，到多维表格主链路管理和审批实例查询 / 操作。

安装

npm install -g @dtyq/teamshare-cli
teamshare-cli install
teamshare-cli --version

teamshare-cli install 会把 npm 包内置的 Teamshare AI Skills 安装到全局 skill 目录；只需要 CLI 命令时可跳过。

当前能力总览

配置与凭证

Agent 登录流程：

用户未指定登录入口时，Agent 只展示以下三个选项，不先执行 config envs：

1. 天书中国站（teamshare.cn）
2. 天书国际站（teamshareos.com）
3. 私有化企业登录（使用企业专属域名）

公开站点直接发起登录：

teamshare-cli auth login --env teamshare    # 天书中国站
teamshare-cli auth login --env teamshareos  # 天书国际站

私有化企业登录未提供识别码时，Agent 先询问“私有部署识别码”，再按以下链路执行：

config envs --code → config set → auth login

具体命令和字段映射见 Config Reference。

# 第一次登录返回授权链接；用户在浏览器完成授权后执行
teamshare-cli auth login

其他常用命令：

teamshare-cli config status              # 查看当前环境与登录状态
teamshare-cli auth status                # 查看 credential 状态
teamshare-cli auth logout                # 退出登录（切环境/换账号前必须先执行）

Base 业务命令

当前 Base 已覆盖 9 类对象，共 49 条命令：

| 模块 | 数量 | 能力 | | --- | ---: | --- | | File | 5 | 多维表格文件创建、列表、详情、重命名、删除 | | Directory | 5 | 文件内目录创建、列表、详情、重命名、删除 | | Sheet | 5 | 文件内数据表创建、列表、详情、重命名、删除 | | Field | 5 | 字段创建、列表、详情、完整更新、删除 | | Record | 6 | 单条创建/更新、批量创建、批量更新、列表、详情、删除 | | View | 5 | 普通视图创建、列表、详情、重命名、删除 | | Form | 7 | 表单创建、列表、详情、配置、字段配置、重命名、删除 | | Dashboard | 6 | 仪表盘创建、列表、详情、重命名、布局替换、删除 | | Widget | 5 | 仪表盘组件创建、列表、详情、更新、删除 |

Approval 业务命令

当前 Approval 已覆盖审批实例查询和常见操作，共 10 条命令：

| 模块 | 数量 | 能力 | | --- | ---: | --- | | Instance | 10 | 审批实例列表、详情、同意、拒绝、办理、评论、撤回、催办、转交、分享 |

执行前阅读

本 README 只提供能力总览和命令索引，不承载完整参数、JSON 结构、写入前置条件和易错点。

• 登录 / 配置 / 鉴权错误：先阅读 skills/teamshare-shared/SKILL.md
• 多维表格业务命令：先阅读 skills/teamshare-base/SKILL.md，再按目标模块进入 skills/teamshare-base/references 下对应命令文档
• 审批实例业务命令：先阅读 skills/teamshare-approval/SKILL.md，再阅读 skills/teamshare-approval/references/teamshare-approval-instance.md

当前命令清单

approval instance（10）

teamshare-cli approval +instance-list
teamshare-cli approval +instance-list --json '{"keyword":"报销","page":1,"page_size":20}'
teamshare-cli approval +instance-get --instance-id <instance_id>
teamshare-cli approval +instance-agree --instance-id <instance_id> --json '{"content":"同意"}' --yes
teamshare-cli approval +instance-reject --instance-id <instance_id> --json '{"content":"不同意，请补充材料"}' --yes
teamshare-cli approval +instance-handle --instance-id <instance_id> --json '{"content":"已办理"}' --yes
teamshare-cli approval +instance-comment --instance-id <instance_id> --json '{"content":"补充说明"}'
teamshare-cli approval +instance-recall --instance-id <instance_id> --yes
teamshare-cli approval +instance-urge --instance-id <instance_id>
teamshare-cli approval +instance-forward --instance-id <instance_id> --json '{"forward_user_id":"<user_id>","content":"请协助处理"}' --yes
teamshare-cli approval +instance-share --instance-id <instance_id> --json '{"user_ids":["<user_id>"]}' --yes

+instance-agree、+instance-reject、+instance-handle、+instance-recall、+instance-forward、+instance-share 是高风险写入，核对目标并得到用户确认后追加 --yes。

file（5）

teamshare-cli base +file-create --name "..."
teamshare-cli base +file-list
teamshare-cli base +file-get --file-id <file_id>
teamshare-cli base +file-update --file-id <file_id> --name "..."
teamshare-cli base +file-delete --file-id <file_id> --yes

directory（5）

teamshare-cli base +directory-create --file-id <file_id> --name "..."
teamshare-cli base +directory-list --file-id <file_id>
teamshare-cli base +directory-get --directory-id <directory_id>
teamshare-cli base +directory-rename --directory-id <directory_id> --name "..."
teamshare-cli base +directory-delete --directory-id <directory_id> --yes

sheet（5）

teamshare-cli base +sheet-create --file-id <file_id> --name "..."
teamshare-cli base +sheet-create --file-id <file_id> --directory-id <directory_id> --name "..."
teamshare-cli base +sheet-list --file-id <file_id>
teamshare-cli base +sheet-get --sheet-id <sheet_id>
teamshare-cli base +sheet-update --sheet-id <sheet_id> --name "..."
teamshare-cli base +sheet-delete --sheet-id <sheet_id> --yes

field（5）

teamshare-cli base +field-create --sheet-id <sheet_id> --json '{"name":"...","type":"text"}'
teamshare-cli base +field-list --sheet-id <sheet_id>
teamshare-cli base +field-get --sheet-id <sheet_id> --field-id <field_id>
teamshare-cli base +field-update --sheet-id <sheet_id> --field-id <field_id> --json '{"name":"...","type":"text"}'
teamshare-cli base +field-delete --sheet-id <sheet_id> --field-id <field_id> --yes

当前字段定义能力覆盖：text / number / select / multiple / datetime / checkbox / link / created_at / updated_at / modifier / creator / auto_id。

其中系统只读字段支持字段定义创建、更新和读取，不支持 record 写入。

record（6）

teamshare-cli base +record-upsert --sheet-id <sheet_id> --json '{"fields":{"<field_id>":"value"}}'
teamshare-cli base +record-upsert --sheet-id <sheet_id> --record-id <record_id> --json '{"fields":{"<field_id>":"value"}}'
teamshare-cli base +record-batch-create --sheet-id <sheet_id> --json '{"records":[{"fields":{"<field_id>":"v1"}},{"fields":{"<field_id>":"v2"}}]}'
teamshare-cli base +record-batch-update --sheet-id <sheet_id> --json '{"record_ids":["..."],"fields":{"<field_id>":"value"}}'
teamshare-cli base +record-list --sheet-id <sheet_id>
teamshare-cli base +record-get --sheet-id <sheet_id> --record-id <record_id>
teamshare-cli base +record-delete --sheet-id <sheet_id> --record-id <record_id> --yes

当前 record 写入能力覆盖：text / number / select / multiple / datetime / checkbox / link。

view（5）

teamshare-cli base +view-create --sheet-id <sheet_id> --json '[{"name":"...","type":"table"}]'
teamshare-cli base +view-list --sheet-id <sheet_id>
teamshare-cli base +view-get --sheet-id <sheet_id> --view-id <view_id>
teamshare-cli base +view-rename --sheet-id <sheet_id> --view-id <view_id> --name "..."
teamshare-cli base +view-delete --sheet-id <sheet_id> --view-id <view_id> --yes

普通视图当前按 table / kanban / gantt / gallery 使用。表单视图使用 +form-* 命令。

form（7）

teamshare-cli base +form-create --sheet-id <sheet_id> --name "..."
teamshare-cli base +form-list --sheet-id <sheet_id>
teamshare-cli base +form-get --sheet-id <sheet_id> --view-id <view_id>
teamshare-cli base +form-config --sheet-id <sheet_id> --view-id <view_id> --json '{...}'
teamshare-cli base +form-field-config --sheet-id <sheet_id> --view-id <view_id> --json '[{...}]'
teamshare-cli base +form-rename --sheet-id <sheet_id> --view-id <view_id> --name "..."
teamshare-cli base +form-delete --sheet-id <sheet_id> --view-id <view_id> --yes

Form 是数据表下的表单视图，不是独立表单系统。表单字段只能来自数据表字段。

dashboard（6）

teamshare-cli base +dashboard-create --file-id <file_id> --name "..."
teamshare-cli base +dashboard-create --file-id <file_id> --directory-id <directory_id> --name "..."
teamshare-cli base +dashboard-list --file-id <file_id>
teamshare-cli base +dashboard-get --dashboard-id <dashboard_id>
teamshare-cli base +dashboard-update --dashboard-id <dashboard_id> --name "..."
teamshare-cli base +dashboard-set-layouts --dashboard-id <dashboard_id> --json '{"layouts":[{"i":"<widget_id>","x":0,"y":0,"w":12,"h":6}]}'
teamshare-cli base +dashboard-delete --dashboard-id <dashboard_id> --yes

widget（5）

teamshare-cli base +widget-list --dashboard-id <dashboard_id>
teamshare-cli base +widget-get --dashboard-id <dashboard_id> --widget-id <widget_id>
teamshare-cli base +widget-create --dashboard-id <dashboard_id> --json '{"widget":{"name":"说明","type":"rich-text","html":"<p>说明</p>"}}'
teamshare-cli base +widget-update --dashboard-id <dashboard_id> --widget-id <widget_id> --json '{"widget":{...}}'
teamshare-cli base +widget-delete --dashboard-id <dashboard_id> --widget-id <widget_id> --yes

当前 widget 文档覆盖 rich-text、indicator 和常见 chart 结构。图表和指标的数据源使用 widget.sheetId 指向数据表；不要把 dashboard_id 当作数据源 ID。