Relevant source files

The following files were used as context for generating this wiki page: - [src/commands/templates/index.ts](https://github.com/resend/resend-cli/blob/main/src/commands/templates/index.ts) - [src/commands/templates/create.ts](https://github.com/resend/resend-cli/blob/main/src/commands/templates/create.ts) - [src/commands/templates/update.ts](https://github.com/resend/resend-cli/blob/main/src/commands/templates/update.ts) - [src/commands/templates/publish.ts](https://github.com/resend/resend-cli/blob/main/src/commands/templates/publish.ts) - [skills/resend-cli/references/templates.md](https://github.com/resend/resend-cli/blob/main/skills/resend-cli/references/templates.md) - [skills/resend-cli/SKILL.md](https://github.com/resend/resend-cli/blob/main/skills/resend-cli/SKILL.md)

# Email Templates Email Templates in the Resend CLI allow developers to manage reusable email content with dynamic variables. These templates support a structured lifecycle, moving from initial draft creation to publication, at which point they can be utilized in live email delivery via a unique `template_id` or `alias`. Templates utilize a triple-brace syntax (e.g., `{{{VAR_NAME}}}`) for variable injection within HTML and plain-text bodies. This system enables the separation of email design and logic from the data being sent, facilitating easier maintenance and A/B testing through duplication and versioning. Sources: [src/commands/templates/index.ts:13-24](), [skills/resend-cli/SKILL.md:46]() ## Template Lifecycle and Workflow Templates follow a specific state progression managed through various CLI subcommands. A template typically begins as a draft and must be published before it can be used for sending emails. ```mermaid graph TD A[Create] -->|Creates Draft| B[Draft State] B --> C[Update] C --> B B --> D[Publish] D -->|Live Version| E[Published State] E --> F[Update] F -->|Creates New Draft| B E --> G[Duplicate] G -->|New Template ID| B E --> H[Delete] B --> H[Delete] ``` The diagram shows the transition of a template from creation through updates and publication. Sources: [src/commands/templates/index.ts:14-20](), [src/commands/templates/publish.ts:11-14]() ### Operations Summary | Operation | Command | Description | |-----------|---------|-------------| | **Create** | `create` | Initializes a new template in draft status. | | **Update** | `update` | Modifies existing fields (name, HTML, subject, etc.) of a template. | | **Publish** | `publish` | Promotes the current draft to the live version. | | **Duplicate** | `duplicate` | Creates a copy of an existing template as a new draft. | | **List** | `list` | Displays a paginated list of available templates. | | **Get** | `get` | Retrieves detailed information for a specific template ID or alias. | | **Delete** | `delete` | Permanently removes a template. | Sources: [src/commands/templates/index.ts:14-20](), [skills/resend-cli/references/templates.md:5-52]() ## Content and Variables Templates support both HTML and plain-text bodies. Variables are declared using the `--var` flag during creation or updates and must follow the `KEY:type` or `KEY:type:fallback` format. ### Variable Syntax Variables use triple-brace syntax `{{{VAR_NAME}}}` in the HTML or text body to prevent unintended escaping of content. The CLI supports two primary variable types: * `string` * `number` Sources: [src/commands/templates/index.ts:22-24](), [src/commands/templates/create.ts:26-29]() ### Variable Declaration Example ```bash resend templates create \ --name "Order Confirmation" \ --html "

Hi {{{NAME}}}, your total is {{{PRICE}}}

" \ --var NAME:string \ --var PRICE:number:0 ``` Sources: [src/commands/templates/create.ts:38-39]() ## Technical Implementation Details ### Creation Logic When creating a template, the `--name` and a body (either `--html` or `--html-file`) are required. If run in interactive mode, the CLI will prompt for these fields if they are missing. ```mermaid sequenceDiagram participant U as User participant C as CLI (create.ts) participant S as Resend SDK U->>C: resend templates create --name "Welcome" alt No HTML provided C->>U: Prompt for HTML body U-->>C: "

Hello

" end C->>S: resend.templates.create({ name, html, ... }) S-->>C: { id: "template_123" } C-->>U: "Template created: template_123" ``` The sequence shows the interactive flow for template creation when mandatory flags are omitted. Sources: [src/commands/templates/create.ts:51-118]() ### Update and Publication Updates are additive; only provided fields are modified while others remain as-is. However, if a template is already published, performing an update creates a new draft. The `publish` command must be called again to make those changes live for email delivery. Sources: [src/commands/templates/update.ts:31-33](), [src/commands/templates/publish.ts:11-13]() ### Error Handling The template module defines specific error codes for common failure scenarios: | Error Code | Cause | |------------|-------| | `missing_name` | No `--name` provided in non-interactive mode. | | `missing_body` | No `--html` or `--html-file` provided. | | `no_changes` | `update` called without any option flags. | | `file_read_error` | The path provided in `--html-file` could not be read. | | `publish_error` | The API rejected the publication request. | Sources: [src/commands/templates/create.ts:31-37](), [src/commands/templates/update.ts:35-40](), [src/commands/templates/publish.ts:15]() ## Usage in CI/CD and Automation In non-interactive environments, the CLI requires all mandatory flags and outputs structured JSON. This is critical for automation where scripts need to capture the `id` of a newly created template to perform subsequent `publish` or `send` actions. Sources: [skills/resend-cli/SKILL.md:14-23](), [src/commands/templates/create.ts:40]() **Example Create and Publish Script:** ```bash # Create template and capture ID TEMPLATE_ID=$(resend templates create --name "CI Template" --html "Build Passed" --json | jq -r '.id') # Publish the template resend templates publish $TEMPLATE_ID --json ``` Sources: [src/commands/templates/publish.ts:20-21](), [skills/resend-cli/SKILL.md:14-17]() The Email Templates system provides a robust framework for managing versioned, variable-driven email content through a clear draft-to-publish lifecycle, ensuring that production email content can be updated safely and predictably via the CLI.