@email-kit/cli 1.0.1 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -45,6 +45,13 @@ npx email-kit new <id> # another template, with messages in every locale
45
45
  The [getting started guide](https://email-kit.dev/guide/getting-started/) goes through it step by
46
46
  step, and [your first email](https://email-kit.dev/guide/first-email/) builds one from scratch.
47
47
 
48
+ ### With an AI coding agent
49
+
50
+ `init` also asks which AI coding agents you use (Claude Code, Codex, Cursor, GitHub Copilot, Gemini
51
+ CLI, Antigravity, Windsurf and others) and writes a skill that teaches them email-kit, for the
52
+ version you have. Run `npx email-kit agents` to add one later or update it after an upgrade. See
53
+ [AI coding agents](https://email-kit.dev/guide/ai-agents/).
54
+
48
55
  ## A template
49
56
 
50
57
  Each template is a folder with `template.tsx` and a `messages.<locale>.json` per language:
@@ -81,7 +88,7 @@ They work together and are released together: install the same version of each.
81
88
  | Package | What it is | Install as |
82
89
  |---|---|---|
83
90
  | [`create-email-kit`](https://www.npmjs.com/package/create-email-kit) | `npm create email-kit`: runs `email-kit init` in the folder you're in | not installed |
84
- | [`@email-kit/cli`](https://www.npmjs.com/package/@email-kit/cli) | The `email-kit` command: `init`, `new`, `compile`, `check` and `tokens` | devDependency |
91
+ | [`@email-kit/cli`](https://www.npmjs.com/package/@email-kit/cli) | The `email-kit` command: `init`, `new`, `compile`, `check`, `tokens` and `agents` | devDependency |
85
92
  | [`@email-kit/core`](https://www.npmjs.com/package/@email-kit/core) | What templates are written with: `defineEmail`, the JSX runtime, `If`/`Each`/`Unless`, field markers (`url`, `secret`, `formatted`), `defineConfig` and `defineCheck` | devDependency |
86
93
  | [`@email-kit/components`](https://www.npmjs.com/package/@email-kit/components) | Email-safe components themed from your shadcn CSS or design tokens: `Text`, `Heading`, `Link`, `Button`, `Image`, `Divider`, `Spacer`, `Section`, `List`, `KeyValue`, `Callout`, `OtpCode`, `DataTable`, `LineItems` and `Footer` | devDependency |
87
94
  | [`@email-kit/runtime`](https://www.npmjs.com/package/@email-kit/runtime) | Renders the compiled emails. The only one your app needs when it runs | **dependency** |
@@ -114,7 +121,7 @@ Outlook especially), and the preview studio.
114
121
  ## More
115
122
 
116
123
  - [Guide](https://email-kit.dev/guide/): templates, components, messages and locales, theme and dark
117
- mode, checks and CI, rendering and sending.
124
+ mode, checks and CI, rendering and sending, and AI coding agents.
118
125
  - Reference: [CLI](https://email-kit.dev/reference/cli/),
119
126
  [configuration](https://email-kit.dev/reference/configuration/),
120
127
  [checks](https://email-kit.dev/reference/checks/), [errors](https://email-kit.dev/reference/errors/).