Skip to main content

Using with Codex

Codex is OpenAI's cloud-based coding agent. It reads skill files from the .agents/skills/ directory in your project.

Install

npx skills add unlayer/unlayer-skills --agent codex

Skills are installed to .agents/skills/ in your project directory.

Verify

Confirm the skill files are in place:

ls .agents/skills/unlayer*

You should see folders: unlayer/, unlayer-integration/, unlayer-custom-tools/, unlayer-export/, and unlayer-config/.

How It Works in Codex

Codex reads .agents/skills/ files and uses them as context when executing tasks. The skills provide Codex with:

  • Accurate API signatures for unlayer.init(), exportHtml(), loadDesign(), and all other methods
  • Working code examples for React, Vue, Angular, and plain JavaScript
  • Email-safe HTML patterns for custom tool exporters
  • Correct configuration options for merge tags, HMAC security, file storage, and more

Example Prompts

Try these in your Codex session:

PromptWhat You'll Get
"Add the Unlayer email editor to my React app"Complete component with save/load pattern
"Create a custom product card tool"Full registerTool call with renderer, exporters, and properties
"Export the design as HTML and save to my API"exportHtml with proper design JSON handling
"Set up custom image uploads to S3"registerCallback with FormData upload pattern
"Configure HMAC security for user identification"Server-side signature generation + client-side init

Update

npx skills update