Back to Details

docuseal-cli

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Agent Protocol

Agent协议

Rules for agents:
  • Supply ALL required flags — the CLI will not prompt for missing parameters.
  • Output is always JSON.
  • Use 
    -d key=value
    (bracket notation) or 
    -d '{"..": ".."}'
    (JSON) for body and array parameters.
Agent规则：
  • 提供所有必填参数——CLI不会提示补充缺失的参数。
  • 输出始终为JSON格式。
  • 对于请求体和数组参数，使用
    -d key=value
    （括号表示法）或
    -d '{"..": ".."}'
    （JSON格式）。

Authentication

身份验证

Set environment variables:
  • DOCUSEAL_API_KEY
    — API key (required). Get yours at https://console.docuseal.com/api
  • DOCUSEAL_SERVER
    — 
    global
    (default), 
    europe
    , or full URL for self-hosted (e.g. 
    https://docuseal.yourdomain.com
    )
设置环境变量：
  • DOCUSEAL_API_KEY
    —— API密钥（必填）。可前往https://console.docuseal.com/api获取
  • DOCUSEAL_SERVER
    —— 
    global
    （默认）、
    europe
    ，或者自部署实例的完整URL（例如
    https://docuseal.yourdomain.com
    ）

Available Commands

可用命令

Command GroupWhat it does
templates
list, retrieve, update, archive, create-pdf, create-docx, create-html, clone, merge, update-documents
submissions
list, retrieve, archive, create, send-emails, create-pdf, create-docx, create-html, documents
submitters
list, retrieve, update
Read the matching reference file for detailed flags and examples.
命令组功能
templates
列出、获取、更新、归档、从PDF创建、从DOCX创建、从HTML创建、克隆、合并、更新文档
submissions
列出、获取、归档、创建、发送邮件、生成PDF、生成DOCX、生成HTML、管理文档
submitters
列出、获取、更新
查看对应的参考文件获取详细参数和示例。

Common Mistakes

常见错误

#MistakeFix
1Forgetting 
-d template_id=<id>
on 
submissions create
--template-id
is a flag; submitters and other body params go via 
-d
2Passing a plain file path as a URL
--file
accepts a local path; for remote files use 
-d "documents[0][file]=https://..."
3Expecting array params as comma-separatedArrays use bracket notation: 
-d "template_ids[]=1"
-d "template_ids[]=2"
4Using 
templates create-pdf
without a Pro plan		Commands marked (Pro) require a DocuSeal Pro subscription
5Sending to multiple recipients with 
submissions create
Use 
submissions send-emails --emails a@b.com,c@d.com
for bulk; 
submissions create
is per-submitter
序号错误修复方案
1在
submissions create
时忘记添加
-d template_id=<id>
--template-id
是一个参数标志；签署人和其他请求体参数需通过
-d
传递
2将本地文件路径当作URL传递
--file
接受本地路径；若使用远程文件，请使用
-d "documents[0][file]=https://..."
3期望数组参数以逗号分隔数组需使用括号表示法：
-d "template_ids[]=1"
-d "template_ids[]=2"
4未订阅Pro计划却使用
templates create-pdf
命令		标记为_(Pro)_的命令需要DocuSeal Pro订阅
5使用
submissions create
发送给多个收件人		批量发送请使用
submissions send-emails --emails a@b.com,c@d.com
；
submissions create
仅支持单个签署人

Security

安全性

The CLI accepts user-provided file paths, remote URLs (
documents[0][file]=https://...
), and HTML content as template input. This is by design — all content originates from the authenticated user and is sent directly to the DocuSeal API over HTTPS. The CLI does not fetch, render, or execute remote content locally; it passes references to the server for processing. No user input is interpolated into shell commands.
CLI接受用户提供的文件路径、远程URL（
documents[0][file]=https://...
）以及HTML内容作为模板输入。这是设计使然——所有内容均来自已认证用户，并通过HTTPS直接发送至DocuSeal API。CLI不会在本地获取、渲染或执行远程内容；它仅将引用传递给服务器进行处理。用户输入不会被插入到Shell命令中。

Common Patterns

常用示例

List templates:
bash
docuseal templates list --q "NDA" --limit 20
Create a template from a PDF and send for signing:
bash
docuseal templates create-pdf --file contract.pdf --name "NDA"
docuseal submissions send-emails --template-id 1001 --emails signer@example.com
Create a submission with pre-filled fields (bracket notation):
bash
docuseal submissions create --template-id 1001 \
  -d "submitters[0][email]=john@acme.com" \
  -d "submitters[0][values][Company Name]=Acme Corp"
Create a submission with pre-filled fields (JSON):
bash
docuseal submissions create --template-id 1001 \
  -d '{"submitters": [{"email": "john@acme.com", "values": {"Company Name": "Acme Corp"}}]}'
Check signing status:
bash
docuseal submissions list --template-id 1001 --status pending
Update a submitter:
bash
docuseal submitters update 201 --email new@acme.com --send-email
列出模板：
bash
docuseal templates list --q "NDA" --limit 20
从PDF创建模板并发送签署请求：
bash
docuseal templates create-pdf --file contract.pdf --name "NDA"
docuseal submissions send-emails --template-id 1001 --emails signer@example.com
创建带有预填字段的提交（括号表示法）：
bash
docuseal submissions create --template-id 1001 \
  -d "submitters[0][email]=john@acme.com" \
  -d "submitters[0][values][Company Name]=Acme Corp"
创建带有预填字段的提交（JSON格式）：
bash
docuseal submissions create --template-id 1001 \
  -d '{"submitters": [{"email": "john@acme.com", "values": {"Company Name": "Acme Corp"}}]}'
检查签署状态：
bash
docuseal submissions list --template-id 1001 --status pending
更新签署人：
bash
docuseal submitters update 201 --email new@acme.com --send-email

When to Load References

何时查看参考文档

  • Creating or managing templates → references/templates.md
  • Sending documents for signing or tracking status → references/submissions.md
  • Using dynamic content variables in DOCX → references/docx-variables.md
  • Embedding field tags in PDF/DOCX → references/field-tags.md
  • Writing HTML templates with field tags → references/html-fields.md
  • Listing or updating signers → references/submitters.md
  • 创建或管理模板 → 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