docuseal-cli

エージェントプロトコル

エージェント向けルール：

• 必須のフラグをすべて指定してください。CLI は不足しているパラメーターを尋ねません。
• 出力は常に JSON です。
• 本文および配列パラメーターには、-d key=value（ブラケット記法）または -d '{"..": ".."}'（JSON）を使用してください。

認証

環境変数を設定します：

• DOCUSEAL_API_KEY — API キー（必須）。https://console.docuseal.com/api で取得してください
• DOCUSEAL_SERVER — global（デフォルト）、europe、またはセルフホスト用の完全な URL（例：https://docuseal.yourdomain.com）

使用可能なコマンド

コマンドグループ	機能
templates	一覧表示、取得、更新、アーカイブ、PDF の作成、DOCX の作成、HTML の作成、複製、結合、ドキュメントの更新
submissions	一覧表示、取得、更新、アーカイブ、作成、メール送信、PDF の作成、DOCX の作成、HTML の作成、ドキュメント
submitters	一覧表示、取得、更新

詳しいフラグと使用例については、該当するリファレンスファイルをお読みください。

よくある間違い

#	間違い	修正方法
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 [email protected],[email protected] を使用します。submissions create は送信者ごとのコマンドです

セキュリティ

CLI は、ユーザーが指定したファイルパス、リモート URL（documents[0][file]=https://...）、およびテンプレート入力としての HTML コンテンツを受け付けます。すべてのコンテンツは認証済みユーザーから提供され、HTTPS 経由で DocuSeal API に直接送信されるため、この仕様は意図されたものです。CLI はリモートコンテンツをローカルで取得、レンダリング、実行することはありません。処理のために参照先をサーバーに渡します。ユーザー入力がシェルコマンドに埋め込まれることはありません。

よく使われるパターン

テンプレートを一覧表示する：

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 [email protected]

事前入力フィールドを指定して送信を作成する（ブラケット記法）：

docuseal submissions create --template-id 1001 \
  -d "submitters[0][email][email protected]" \
  -d "submitters[0][values][Company Name]=Acme Corp"

事前入力フィールドを指定して送信を作成する（JSON）：

docuseal submissions create --template-id 1001 \
  -d '{"submitters": [{"email": "[email protected]", "values": {"Company Name": "Acme Corp"}}]}'

署名状況を確認する：

docuseal submissions list --template-id 1001 --status pending

送信者を更新する：

docuseal submitters update 201 --email [email protected] --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