DocuSeal

Generated DocuSeal CLI and agent Skill for document templates and signing workflows.

$ docuseal search "list templates" --json

CLI binaries 6 platform builds

Skill Included in CLI

Source refs 1 pinned inputs

Smoke intent list templates

01 Schema docuseal commands schema --json

02 Catalog docuseal commands --json

03 Search docuseal search "list templates" --json

Recipe structure

Files

10 files

builds/docuseal.json json

{
  "schema_version": 1,
  "recipe": "docuseal",
  "cli_name": "docuseal",
  "generated_at": "2026-08-21T06:45:37.357Z",
  "lathe_version": "lathe v0.5.2 (none, unknown)",
  "gate": {
    "verdict": "GO",
    "generated_at": "2026-08-21T06:45:37.357Z",
    "lathe_version": "lathe v0.5.2 (none, unknown)",
    "command_count": 22,
    "group_count": 3,
    "skill_included": true,
    "warnings": []
  },
  "source_refs": [
    {
      "name": "docuseal_api",
      "display_name": "docuseal_api",
      "backend": "openapi3",
      "repo_url": "https://github.com/docusealco/docuseal",
      "pinned_tag": "3.1.5",
      "files": [
        "docs/openapi.json"
      ]
    }
  ],
  "outputs": {
    "catalog": null,
    "skill": "skills/docuseal",
    "cli_artifacts": [
      {
        "os": "darwin",
        "arch": "arm64",
        "format": "tar.gz",
        "binary": "docuseal",
        "path": "downloads/docuseal-darwin-arm64.tar.gz",
        "size": 3674436,
        "sha256": "sha256:82bb03aa88500ce0424add5f58822dfa2c3ab346cf93e3347607654b3f2a444b"
      },
      {
        "os": "darwin",
        "arch": "amd64",
        "format": "tar.gz",
        "binary": "docuseal",
        "path": "downloads/docuseal-darwin-amd64.tar.gz",
        "size": 3971557,
        "sha256": "sha256:135843b2fa5e041dbd2dc309173e3b89292d9661e40f307c98c2d5bb0eeb4ebc"
      },
      {
        "os": "linux",
        "arch": "amd64",
        "format": "tar.gz",
        "binary": "docuseal",
        "path": "downloads/docuseal-linux-amd64.tar.gz",
        "size": 3912433,
        "sha256": "sha256:25252e086d1e89220bdcca6cc5a94c25b00476bb4e9ee90da4421696482f4156"
      },
      {
        "os": "linux",
        "arch": "arm64",
        "format": "tar.gz",
        "binary": "docuseal",
        "path": "downloads/docuseal-linux-arm64.tar.gz",
        "size": 3543280,
        "sha256": "sha256:7d21ddb84f827bd1288d0803dceacc1906f4f499e112e87f9aafc0ebfbd4c02b"
      },
      {
        "os": "windows",
        "arch": "amd64",
        "format": "tar.gz",
        "binary": "docuseal.exe",
        "path": "downloads/docuseal-windows-amd64.tar.gz",
        "size": 4028292,
        "sha256": "sha256:c06509531de921ca7f601965c3dc60784aa1bc57e30c75957b0162ca536b2c73"
      },
      {
        "os": "windows",
        "arch": "arm64",
        "format": "tar.gz",
        "binary": "docuseal.exe",
        "path": "downloads/docuseal-windows-arm64.tar.gz",
        "size": 3603540,
        "sha256": "sha256:85c6e6626ace039512a08021f17ccd1cb0d0113375318bbd5f9c89e40d081089"
      }
    ]
  }
}

recipes/docuseal/README.md markdown

# DocuSeal

This recipe generates the `docuseal` CLI and agent Skill for
[DocuSeal](https://github.com/docusealco/docuseal) templates, submissions, and
document-signing workflows.

## API and authentication

Create an API key in DocuSeal, then authenticate with the `X-Auth-Token` header:

```sh
docuseal auth login --hostname api.docuseal.com --auth-type apikey
docuseal auth status --hostname api.docuseal.com
```

Enter `X-Auth-Token` when the login command asks for the header name.

## Install the Skill

```sh
docuseal skill install --scope user --agent codex --yes
```

## Agent workflow

```sh
docuseal commands --json
docuseal search "list templates" --json
```

Use the returned command path with `docuseal commands show` before execution.
Bump the release pin in
`specs/sources.yaml` when upgrading the DocuSeal API.

recipes/docuseal/cli.yaml yaml

cli:
  name: docuseal
  short: "Command-line tool for DocuSeal document workflows"

skill:
  bundle: true

auth:
  validate:
    method: GET
    path: /templates

recipes/docuseal/lathe.yaml yaml

name: docuseal
display_name: DocuSeal
cli_name: docuseal
category: document-automation
homepage: https://github.com/docusealco/docuseal
description: Generated DocuSeal CLI and agent Skill for document templates and signing workflows.
maintainers:
  - github: samzong
auth:
  type: custom
  notes: >-
    Requires an API key in the X-Auth-Token header. Run
    `docuseal auth login --hostname api.docuseal.com --auth-type apikey`,
    enter X-Auth-Token as the header, then verify with `docuseal auth status`.
smoke:
  intent: list templates
  expect: get-templates

recipes/docuseal/specs/sources.yaml yaml

sources:
  docuseal_api:
    default_hostname: api.docuseal.com
    repo_url: https://github.com/docusealco/docuseal
    # pinned to release 3.1.5 as of 2026-07-26; bump when upgrading
    pinned_tag: 3.1.5
    backend: openapi3
    openapi3:
      files:
        - docs/openapi.json

skills/docuseal/.lathe-skill text

generated by lathe codegen; safe to remove and regenerate

skills/docuseal/SKILL.md markdown

---
name: docuseal
description: >
  Use when operating the docuseal generated CLI. Discover commands, inspect parameters,
  check auth state, and execute API operations safely.
---

# docuseal CLI

Use this skill when a user asks you to operate `docuseal`, inspect its API commands, or find the right generated command for an API task.

## Workflow

1. Search for candidates with `docuseal search "<intent>" --json`; use `--limit` when needed. Search is only candidate discovery.
2. Inspect the exact command with `docuseal commands show <path...> --json` before executing an unfamiliar command.
3. If the command detail has `auth.required=true`, run `docuseal auth status --hostname <host>` before execution. Use `http.default_hostname` when present unless the user provides `--hostname` or `$DOCUSEAL_HOST`.
4. Execute only after flags, body, auth, HTTP path, and output hints are clear from `commands show`.

## General Commands

- `docuseal commands --json`: full generated command catalog.
- `docuseal commands --include-hidden --json`: include hidden generated commands.
- `docuseal commands show <path...> --json`: source of truth for one command.
- `docuseal commands schema --json`: catalog schema version for parser compatibility.
- `docuseal search "<intent>" --json`: ranked candidate commands.

## Maintenance Commands

- `docuseal --version` or `docuseal -v`: print CLI build version.

## References

- Read `references/catalog.md` for the command discovery protocol and catalog field meanings.
- Read `references/modules/docuseal-api.md` for the `docuseal_api` module command index.

## Rules

- Do not guess flags or request body shape from command names.
- Do not execute directly from search results; confirm with `commands show` first.
- Prefer `-o json` for machine-readable command output unless the user asks for human-readable output.
- Use `--file`, `--set`, or `--set-str` for JSON request bodies according to `commands show` body requirements.
- For sensitive flags, prefer safe modes from `flags[].input_modes`: `--<flag>-env`, `--<flag>-file`, or `--<flag>-stdin`.

skills/docuseal/agents/openai.yaml yaml

interface:
  display_name: "docuseal CLI"
  short_description: "Use the docuseal generated CLI"
  default_prompt: "Use $docuseal to find and run the right docuseal command."

skills/docuseal/references/catalog.md markdown

# Catalog Protocol

Use the runtime catalog as the source of truth. Generated references are a fast index; command execution details come from the CLI itself.

## Search

Run `docuseal search "<intent>" --json` to find candidate commands. Use `--limit` to control result count. Treat search output as candidates only.

## Full Catalog

Run `docuseal commands --json` to inspect the generated command catalog. Use `--include-hidden` only when hidden commands are relevant.

Key fields:

- `path`: command path to pass to `commands show` or execute after the CLI name.
- `shortcuts`: root-level commands that execute the same operation with preset flag values.
- `http`: HTTP method and path template.
- `http.default_hostname`: optional source-level host selected after explicit `--hostname` and `$DOCUSEAL_HOST`; when present it is used before the single-host fallback from `hosts.yml`.
- `flags`: CLI flags, parameter location, type, required state, defaults, enum values, format, input modes, and help.
- `body`: request body requirement and media type.
- `auth`: whether auth is required and which scopes are declared.
- `examples`: runnable examples with optional body shape, output hints, and follow-up commands.
- `output`: list path, default columns, response media type, pagination, and streaming hints.
- `notes`, `prerequisites`, and `known_errors`: overlay-provided operation context that is not inferred from the API spec.

## Command Detail

Run `docuseal commands show <path...> --json` before executing an unfamiliar command. This is the source of truth for flags, body, auth, HTTP path, and output hints.

## Schema

Run `docuseal commands schema --json` to read the catalog schema version before parsing catalog JSON with durable tooling.

## Sensitive Flags

When a flag entry has `input_modes`, prefer safe modes over putting secrets directly in shell arguments.

- `flag`: pass the direct `--<flag>` value; keep this for compatibility or non-secret values.
- `env`: pass `--<flag>-env NAME` to read the value from an environment variable.
- `file`: pass `--<flag>-file path` to read the value from a file.
- `stdin`: pass `--<flag>-stdin` to read the value from stdin.
- Use only one input mode for the same flag.

## Request Bodies

- `--file path`: read a JSON body from a file.
- `--file -`: read a JSON body from stdin.
- `--set key.path=value`: build JSON with type inference for booleans, null, integers, and floats.
- `--set-str key.path=value`: build JSON while forcing the value to remain a string.

## Output

Use `-o json` for machine-readable command output. Other supported formats are `table`, `yaml`, and `raw`.

## Auth

If command detail returns `auth.required=true`, run `docuseal auth status --hostname <host>` before execution. Use `http.default_hostname` when present unless the user provides `--hostname` or `$DOCUSEAL_HOST`; if no matching host is logged in, stop and ask the user to authenticate.

skills/docuseal/references/modules/docuseal-api.md markdown

# Module `docuseal_api`

## Source

- Backend: `openapi3`
- Default hostname: `api.docuseal.com`
- Repository: https://github.com/docusealco/docuseal
- Pinned tag: `3.1.5`
- Files: `docs/openapi.json`
- Resolved SHA: `5fe75c84ffc71d1e879884f453a7532b4dee049a`

## Submissions

### `docuseal submissions archive-submission`

- Summary: Archive a submission
- HTTP: `DELETE /submissions/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): The unique identifier of the submission.
- Output: response media `application/json`

### `docuseal submissions create-submission`

- Summary: Create a submission
- HTTP: `POST /submissions`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `docuseal submissions create-submission-from-docx`

- Summary: Create a submission from DOCX
- HTTP: `POST /submissions/docx`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
- Output: list path `fields`; response media `application/json`

### `docuseal submissions create-submission-from-html`

- Summary: Create a submission from HTML
- HTTP: `POST /submissions/html`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
- Output: list path `fields`; response media `application/json`

### `docuseal submissions create-submission-from-pdf`

- Summary: Create a submission from PDF
- HTTP: `POST /submissions/pdf`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
- Output: list path `fields`; response media `application/json`

### `docuseal submissions create-submissions-from-emails`

- Summary: Create submissions from emails
- HTTP: `POST /submissions/emails`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `docuseal submissions get-submission`

- Summary: Get a submission
- HTTP: `GET /submissions/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): The unique identifier of the submission.
- Output: list path `documents`; response media `application/json`

### `docuseal submissions get-submission-documents`

- Summary: Get submission documents
- HTTP: `GET /submissions/{id}/documents`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): The unique identifier of the submission.
  - `--merge` (query, default `false`): When `true`, merges all documents into a single PDF.
- Output: list path `documents`; response media `application/json`

### `docuseal submissions get-submissions`

- Summary: List all submissions
- HTTP: `GET /submissions`
- Auth: required
- Body: none
- Flags:
  - `--template_id` (query): The template ID allows you to receive only the submissions created from that specific template.
  - `--status` (query, one of: pending|completed|declined|expired): Filter submissions by status.
  - `--q` (query): Filter submissions based on submitter's name, email or phone partial match.
  - `--slug` (query): Filter submissions by unique slug.
  - `--template_folder` (query): Filter submissions by template folder name.
  - `--archived` (query): Returns only archived submissions when `true` and only active submissions when `false`.
  - `--limit` (query): The number of submissions to return. Default value is 10. Maximum value is 100.
  - `--after` (query): The unique identifier of the submission to start the list from. It allows you to receive only submissions with an ID greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of submissions.
  - `--before` (query): The unique identifier of the submission that marks the end of the list. It allows you to receive only submissions with an ID less than the specified value.
- Output: list path `data`; response media `application/json`; pagination `cursor`

## Submitters

### `docuseal submitters get-submitter`

- Summary: Get a submitter
- HTTP: `GET /submitters/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): The unique identifier of the submitter.
- Output: list path `documents`; response media `application/json`

### `docuseal submitters get-submitters`

- Summary: List all submitters
- HTTP: `GET /submitters`
- Auth: required
- Body: none
- Flags:
  - `--submission_id` (query): The submission ID allows you to receive only the submitters related to that specific submission.
  - `--q` (query): Filter submitters on name, email or phone partial match.
  - `--slug` (query): Filter submitters by unique slug.
  - `--completed_after` (query, date-time): The date and time string value to filter submitters that completed the submission after the specified date and time.
  - `--completed_before` (query, date-time): The date and time string value to filter submitters that completed the submission before the specified date and time.
  - `--external_id` (query): The unique application-specific identifier provided for a submitter when initializing a signature request. It allows you to receive only submitters with a specified external ID.
  - `--limit` (query): The number of submitters to return. Default value is 10. Maximum value is 100.
  - `--after` (query): The unique identifier of the submitter to start the list from. It allows you to receive only submitters with an ID greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of submitters.
  - `--before` (query): The unique identifier of the submitter to end the list with. It allows you to receive only submitters with an ID less than the specified value.
- Output: list path `data`; response media `application/json`; pagination `cursor`

### `docuseal submitters update-submitter`

- Summary: Update a submitter
- HTTP: `PUT /submitters/{id}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--id` (path, required): The unique identifier of the submitter.
- Output: list path `documents`; response media `application/json`

## Templates

### `docuseal templates add-document-to-template`

- Summary: Update template documents
- HTTP: `PUT /templates/{id}/documents`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--id` (path, required): The unique identifier of the document template.
- Output: list path `documents`; response media `application/json`

### `docuseal templates archive-template`

- Summary: Archive a template
- HTTP: `DELETE /templates/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): The unique identifier of the document template.
- Output: response media `application/json`

### `docuseal templates clone-template`

- Summary: Clone a template
- HTTP: `POST /templates/{id}/clone`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--id` (path, required): The unique identifier of the document template.
- Output: list path `documents`; response media `application/json`

### `docuseal templates create-template-from-docx`

- Summary: Create a template from Word DOCX
- HTTP: `POST /templates/docx`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
- Output: list path `documents`; response media `application/json`

### `docuseal templates create-template-from-html`

- Summary: Create a template from HTML
- HTTP: `POST /templates/html`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
- Output: list path `documents`; response media `application/json`

### `docuseal templates create-template-from-pdf`

- Summary: Create a template from PDF
- HTTP: `POST /templates/pdf`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
- Output: list path `documents`; response media `application/json`

### `docuseal templates get-template`

- Summary: Get a template
- HTTP: `GET /templates/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): The unique identifier of the document template.
- Output: list path `documents`; response media `application/json`

### `docuseal templates get-templates`

- Summary: List all templates
- HTTP: `GET /templates`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): Filter templates based on the name partial match.
  - `--slug` (query): Filter templates by unique slug.
  - `--external_id` (query): The unique application-specific identifier provided for the template via API or Embedded template form builder. It allows you to receive only templates with your specified external ID.
  - `--folder` (query): Filter templates by folder name.
  - `--archived` (query): Get only archived templates instead of active ones.
  - `--limit` (query): The number of templates to return. Default value is 10. Maximum value is 100.
  - `--after` (query): The unique identifier of the template to start the list from. It allows you to receive only templates with an ID greater than the specified value. Pass ID value from the `pagination.next` response to load the next batch of templates.
  - `--before` (query): The unique identifier of the template to end the list with. It allows you to receive only templates with an ID less than the specified value.
- Output: list path `data`; response media `application/json`; pagination `cursor`

### `docuseal templates merge-template`

- Summary: Merge templates
- HTTP: `POST /templates/merge`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
- Output: list path `documents`; response media `application/json`

### `docuseal templates update-template`

- Summary: Update a template
- HTTP: `PUT /templates/{id}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--id` (path, required): The unique identifier of the document template.
- Output: response media `application/json`

DocuSeal

This recipe generates the docuseal CLI and agent Skill for DocuSeal templates, submissions, and document-signing workflows.

API and authentication

Create an API key in DocuSeal, then authenticate with the X-Auth-Token header:

docuseal auth login --hostname api.docuseal.com --auth-type apikey
docuseal auth status --hostname api.docuseal.com

Enter X-Auth-Token when the login command asks for the header name.

Install the Skill

docuseal skill install --scope user --agent codex --yes

Agent workflow

docuseal commands --json
docuseal search "list templates" --json

Use the returned command path with docuseal commands show before execution. Bump the release pin in specs/sources.yaml when upgrading the DocuSeal API.