DocuSeal CLI
https://github.com/docusealco/docuseal-cli- Category
- Developer Tools
- Rank
- No. 1647Tools index
Previous survey · No. 1695 ·
- Pricing
- Open Source
- Type
- TOOL
- Builder
- docusealco
- GitHub
- 3 stars
- Date
About
Command-line tool for the DocuSeal eSignature platform. Send, sign, and manage documents from your terminal or AI agents.
What it does
DocuSeal CLI turns e-signature operations into scriptable commands grouped around templates, submissions, and submitters. It authenticates against global, European, or self-hosted DocuSeal servers, accepts structured request data, uploads local documents, and prints API responses as JSON.
Why it's ranked here
The command surface covers a meaningful document lifecycle, from creating templates through tracking submissions and updating signers. Flexible data input preserves access to API parameters, while server overrides and machine-readable output suit automation. Tests verify configuration behavior and representative template requests.
What's good
Configuration has a clear precedence order: command flags, environment variables, then the credentials file. Local files are converted to base64 automatically when used in structured data. Repeated bracket notation and JSON inputs support nested fields, roles, metadata, signing order, and notification settings.
Tradeoffs
It requires Node.js 18 or newer and a DocuSeal API token. PDF, DOCX, and HTML creation commands are marked Pro. Credentials remain in a local JSON file, protected with owner-only permissions. Rich requests can become verbose because nested API structures pass through a generic data flag.
How to use it well
Use it for shell scripts, CI jobs, or agent workflows that already depend on DocuSeal and benefit from JSON responses. Prefer environment variables or per-command credentials in automated environments. It does not replace document authoring, a signer-facing interface, or the underlying e-signature service.
Technical notes+
package.json defines an ESM npm package named docuseal, requires the bundled CLI entry through bin/run.js, and uses Commander, @docuseal/api, and qs. src/index.js registers the command groups. src/lib/config.js resolves global, Europe, and self-hosted endpoints, applies flag, environment, and file precedence, and writes credentials with mode 0600. src/lib/data-flags.js parses bracket notation to depth 10, merges JSON payloads, blocks prototype-related merge keys, and base64-encodes existing local files. src/lib/api.js converts DocuSeal API failures into JSON and exits nonzero. tests/config.test.js checks endpoint resolution, while tests/templates.test.js exercises CLI requests against a local HTTP server.
Observed
- License
- MIT
- Primary language
- JavaScript using ECMAScript modules
- Packaging
- npm package named docuseal, runnable with npx or installable globally
- Runtime
- Node.js 18 or newer
- Interface
- Command-line client wrapping the DocuSeal API
- Server support
- DocuSeal global, DocuSeal Europe, and full self-hosted URLs
- Testing
- Uses the built-in Node.js test runner, with configuration and template request suites present
Read from README.md, package.json, src/index.js, src/lib/api.js, src/lib/config.js, src/lib/output.js, src/lib/data-flags.js, src/commands/configure.js, src/commands/templates.js, src/lib/global-options.js, src/commands/submitters.js, src/commands/submissions.js, bin/run.js, tests/config.test.js, tests/templates.test.js.
What it can do
Send documents for signature
Document files and recipient information → Signature requests sent to recipients
Sign documents electronically
Document requiring signature → Digitally signed document
Track document status
Document ID or reference → Current status and progress information
Manage signature workflows
Workflow configuration and document parameters → Automated signature process execution
Retrieve signed documents
Document reference or ID → Completed signed document files
Execute signature operations via AI agents
AI agent commands and document data → Automated signature process results
Tags
Tech Stack
Media
Comments (0)
No comments yet
Editorially curated, with community endorsements as a secondary signal. Corrections welcome.