SuperAPI AI 工具集

docuseal-cli

办公与效率

查看项目

更新于 10-15 15:19

技能介绍

docuseal-cli 是 DocuSeal 生态中的命令行工具技能,目标是在终端中管理 DocuSeal 的电子签名工作流。该技能以“智能体协议”的方式使用,资料明确给出了若干规则:必须提供所有必需参数,CLI 不会对缺失参数进行交互式提示;输出始终为 JSON;请求体和数组参数通过 -d 传入,既支持 key=value 的括号表示法,也支持 JSON 字符串形式。

认证方面,需要通过环境变量配置:DOCUSEAL_API_KEY 是必需项,可在 https://console.docuseal.com/api 获取;DOCUSEAL_SERVER 用于指定服务器,可选 global(默认)、europe,或自托管的完整 URL,例如 https://docuseal.yourdomain.com。

命令按三组组织。templates 组支持列出、检索、更新、归档模板,以及 create-pdf、create-docx、create-html、clone、merge、update-documents。submissions 组支持列出、检索、更新、归档提交,以及 create、send-emails、create-pdf、create-docx、create-html、documents。submitters 组支持列出、检索、更新签署人。每类命令的详细标志与示例需查阅对应的参考文件。

资料列出了常见错误及修正方式:创建提交时忘记提供 -d template_id=<id>,需注意 --template-id 是标志,而 submitters 及其他请求体参数通过 -d 传入;把普通文件路径当作 URL 使用,实际上 --file 接受本地路径,远程文件需用 -d "documents[0][file]=https://...";数组参数不要用逗号分隔,而应使用括号表示法,例如 -d "template_ids[]=1" -d "template_ids[]=2";templates create-pdf 等标记为 Pro 的命令需要 DocuSeal Pro 订阅;为多个收件人发送时不要用 submissions create,而应使用 submissions send-emails --emails a@b.com,c@d.com 进行批量发送,submissions create 是针对单个签署人的。

安全说明指出,CLI 接受用户提供的文件路径、远程 URL 和 HTML 内容作为模板输入,这是刻意设计:所有内容都来自已认证用户,并通过 HTTPS 直接发送给 DocuSeal API。CLI 不会在本地抓取、渲染或执行远程内容,而是将引用传递给服务器处理;用户输入不会被插入到 shell 命令中。

常见使用模式包括:列出模板 docuseal templates list --q "NDA" --limit 20;从 PDF 创建模板并发送签署,先用 docuseal templates create-pdf --file contract.pdf --name "NDA" 创建,再用 docuseal submissions send-emails --template-id 1001 --emails signer@example.com 发送;带预填字段创建提交,可用括号表示法或 JSON 形式,例如 docuseal submissions create --template-id 1001 -d "submitters[0][email]=john@acme.com" -d "submitters[0][values][Company Name]=Acme Corp",或使用 JSON 字符串;检查签署状态可用 docuseal submissions list --template-id 1001 --status pending;更新签署人可用 docuseal submitters update 201 --email new@acme.com --send-email。

何时加载参考文件:创建或管理模板时查阅 references/templates.md;发送文档进行签署或跟踪状态时查阅 references/submissions.md;在 DOCX 中使用动态内容变量时查阅 references/docx-variables.md;在 PDF/DOCX 中嵌入字段标签时查阅 references/field-tags.md;编写含字段标签的 HTML 模板时查阅 references/html-fields.md;列出或更新签署人时查阅 references/submitters.md。

限制与缺失事项:除已提到的 Pro 功能外,资料未提供具体收费与价格信息;未提供 CLI 的安装命令;未说明支持的操作系统与运行环境;也未说明除上述命令外的其他功能。这些内容暂未提供。