@feimacode/open-design-agent-kit 0.1.8 → 0.2.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 +3 -2
- package/assets/claude-skills/open-design/SKILL.md +45 -2
- package/assets/claude-skills/open-design/references/remixable-examples.md +29 -1
- package/assets/claude-skills/open-design-campaign/SKILL.md +61 -0
- package/assets/claude-skills/open-design-deck-from-source/SKILL.md +39 -0
- package/assets/claude-skills/open-design-docs/SKILL.md +52 -0
- package/assets/claude-skills/open-design-explore/SKILL.md +46 -0
- package/assets/claude-skills/open-design-integrations/SKILL.md +40 -0
- package/assets/claude-skills/open-design-new/SKILL.md +31 -0
- package/assets/claude-skills/open-design-poster/SKILL.md +77 -0
- package/assets/claude-skills/open-design-publish/SKILL.md +37 -0
- package/assets/claude-skills/open-design-social-post/SKILL.md +12 -10
- package/assets/codex-skills/open-design/SKILL.md +45 -2
- package/assets/codex-skills/open-design/references/remixable-examples.md +29 -1
- package/assets/codex-skills/open-design-campaign/SKILL.md +60 -0
- package/assets/codex-skills/open-design-deck-from-source/SKILL.md +38 -0
- package/assets/codex-skills/open-design-docs/SKILL.md +51 -0
- package/assets/codex-skills/open-design-explore/SKILL.md +45 -0
- package/assets/codex-skills/open-design-integrations/SKILL.md +39 -0
- package/assets/codex-skills/open-design-new/SKILL.md +30 -0
- package/assets/codex-skills/open-design-poster/SKILL.md +76 -0
- package/assets/codex-skills/open-design-publish/SKILL.md +36 -0
- package/assets/codex-skills/open-design-social-post/SKILL.md +11 -9
- package/out/index.js +164098 -106216
- package/package.json +2 -2
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: open-design-poster
|
|
3
|
+
description: Design a poster or flyer for print or screen, check it, and export print-ready PDFs or upload-ready images, including other sizes and one version per row of a spreadsheet — use whenever the user wants a poster, flyer, event or gig poster, print piece, handout, certificate or name card set, or wants an existing design in other sizes or as a print-ready PDF, even if they don't mention Open Design
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
<!-- generated:open-design-agent-kit -->
|
|
7
|
+
|
|
8
|
+
Design a poster with Open Design, check it, and export files that are ready to print or post.
|
|
9
|
+
|
|
10
|
+
Brief: the rest of the user's message (if there is none, ask the user: "What is the poster for, and is it for print (which size) or screens?")
|
|
11
|
+
|
|
12
|
+
## 1. Pick the medium and a default shape
|
|
13
|
+
|
|
14
|
+
Decide whether this is for **print** or **screens**. If the brief doesn't say, ask the user before doing anything else. Don't guess between print and screen: the units, bleed and type sizes are different.
|
|
15
|
+
|
|
16
|
+
You don't need the final size yet. The poster is built **fluid**: it reflows to any shape, so the user can pick or change the size later, when exporting. Use the size the user names as the default shape; otherwise use `a3` for print and `ig-portrait` for screens, and tell the user they can change it at any time.
|
|
17
|
+
|
|
18
|
+
| Use | Format id | Size |
|
|
19
|
+
|---|---|---|
|
|
20
|
+
| Print, small: flyer, handout | `a4` · `letter` | 210×297 mm · 8.5×11 in |
|
|
21
|
+
| Print, medium: notice-board poster | `a3` · `tabloid` | 297×420 mm · 11×17 in |
|
|
22
|
+
| Print, large: wall poster | `a2` · `a1` · `poster-18x24` · `poster-24x36` | 420×594 mm · 594×841 mm · 18×24 in · 24×36 in |
|
|
23
|
+
| Print, conference or research poster | `a0` | 841×1189 mm |
|
|
24
|
+
| Instagram portrait | `ig-portrait` | 1080×1350 px |
|
|
25
|
+
| Story / Reels / TikTok cover | `story` | 1080×1920 px |
|
|
26
|
+
| X single image | `x-image` | 1600×900 px |
|
|
27
|
+
| Square (Instagram / LinkedIn) | `ig-square` | 1080×1080 px |
|
|
28
|
+
|
|
29
|
+
A handout and a wall poster carry different amounts of text, so if the user says which it is, write the copy for that; the shape itself can still change.
|
|
30
|
+
|
|
31
|
+
## 2. Generate
|
|
32
|
+
|
|
33
|
+
If the user asked for options ("show me a few directions"), run a design exploration first and build out the direction they pick, with the same `format` and `fluid: true`.
|
|
34
|
+
|
|
35
|
+
Otherwise call `prepare_open_design_brief` with:
|
|
36
|
+
|
|
37
|
+
- a `skillId`: `od:prototype:poster-hero` for a bold marketing poster, `od:prototype:magazine-poster` for an editorial or type-led one, or another skill whose style fits better (`list_open_design_skills` with query "poster");
|
|
38
|
+
- the brief, in the user's words;
|
|
39
|
+
- `format`: the default shape from step 1;
|
|
40
|
+
- `fluid: true`.
|
|
41
|
+
|
|
42
|
+
Call `list_open_design_design_systems` first only if the user names a brand or visual direction.
|
|
43
|
+
|
|
44
|
+
Author the file yourself, following the returned instructions. Their **Canvas** section is authoritative: one `data-od-card data-od-fluid` element sized by `--od-w`/`--od-h`, everything inside sized in container units, and layout rules for wide and tall shapes. Also:
|
|
45
|
+
|
|
46
|
+
- Use real copy from the brief, with no lorem ipsum. A poster is read from a distance: one dominant headline, then the what / when / where, then the call to action.
|
|
47
|
+
- If the user gives a list of names, sessions or locations to make one poster each, mark the changing text with `data-od-field="<column name>"` (and a per-person QR slot with `data-od-qr-field="<column>"`), and fill the design with the first row's values.
|
|
48
|
+
- No external image URLs unless the user supplied them. No emoji as key visuals; draw them as inline SVG.
|
|
49
|
+
|
|
50
|
+
## 3. Add a QR code, if it needs one
|
|
51
|
+
|
|
52
|
+
Register the artifact first (step 4), then call `create_open_design_qr_code` with the entry path and the URL, and paste the returned inline SVG where the code goes. Never draw a fake or placeholder QR code.
|
|
53
|
+
|
|
54
|
+
## 4. Register
|
|
55
|
+
|
|
56
|
+
Call `register_open_design_artifact` with the entry path, kind `html`, a title, `sourceSkillId`, and `format` set to the default shape.
|
|
57
|
+
|
|
58
|
+
## 5. Check and fix
|
|
59
|
+
|
|
60
|
+
Call `check_open_design_artifact` with the entry path. It returns the poster as an image plus preflight findings. Fix every **error** in its findings (text cut off, overlapping or in the bleed, a QR code that doesn't decode), and fix warnings where you reasonably can (sizes that don't scale with the poster, small type, low contrast, low-resolution images). Look at the image too: the headline should dominate and nothing important should be cramped or cut. Check again until there are no errors (at most two fix rounds; tell the user about anything left).
|
|
61
|
+
|
|
62
|
+
## 6. Other shapes
|
|
63
|
+
|
|
64
|
+
When the user wants other sizes, or before the final export of a print piece, call `export_open_design_artifact` with `shapeSheet: true` and `checkOnly: true` (add `presets` with just the shapes they care about, or leave it out for every shape). It writes one image of the poster at each shape, marking shapes with errors; show it to the user. If you can view images, look at it too: the headline should dominate every shape and nothing important should be cropped.
|
|
65
|
+
|
|
66
|
+
For a shape that has errors or looks wrong, call `adapt_open_design_artifact` with the entry path and those format ids. For a fluid poster it returns **tune** instructions: fix that shape inside the same file with its `@container` rule, then check every shape again with a shape sheet. Don't create new files for other sizes.
|
|
67
|
+
|
|
68
|
+
## 7. Export
|
|
69
|
+
|
|
70
|
+
- **One shape:** call `export_open_design_artifact` with the entry path and `preset` set to the format id. A print format gives a PDF the size of the bleed box, with trim and bleed boxes set and the bleed added automatically; add `cropMarks: true` if the user's printer wants crop marks. A screen format gives a PNG within the platform's size limit.
|
|
71
|
+
- **Several shapes:** pass `presets` with the format ids instead: one file per shape, named `<name>-<format>`.
|
|
72
|
+
- **One per row of a list:** add `data` with the workspace path of the user's CSV, XLSX or JSON file, and `nameField` with the column to name files by. Images come out one per row; print PDFs come out as one multi-page PDF per shape (add `split: true` for one file per row).
|
|
73
|
+
|
|
74
|
+
## 8. Report
|
|
75
|
+
|
|
76
|
+
List each exported file's path, size and any remaining warnings. For print files, also give the trim size and bleed, and tell the user the PDF is RGB: most print shops convert it, but they should ask if theirs needs CMYK. Mention that the poster can be exported at any other size later without regenerating it. Don't print, post, upload or order anything yourself.
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: open-design-publish
|
|
3
|
+
description: Share an Open Design artifact as a live link (a temporary no-account link, or your own Netlify, Vercel, Cloudflare Pages or GitHub Pages), or as one self-contained HTML file — use whenever the user wants to share, publish, deploy or host an Open Design artifact, or get a link to send to teammates or stakeholders; also when they want a single HTML file to attach or send
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
<!-- generated:open-design-agent-kit -->
|
|
7
|
+
|
|
8
|
+
Share an Open Design artifact with people who don't have this project open.
|
|
9
|
+
|
|
10
|
+
Request: the rest of the user's message (if there is none, ask the user: "Which design should we share, and how?")
|
|
11
|
+
|
|
12
|
+
## 1. Find the artifact
|
|
13
|
+
|
|
14
|
+
If the request names a design, find its entry file (`get_open_design_artifact`, or the `.open-design/` folder). If several match or none is named, ask the user which one. It must be registered; if it isn't, register it first with `register_open_design_artifact`.
|
|
15
|
+
|
|
16
|
+
## 2. A file, or a link?
|
|
17
|
+
|
|
18
|
+
- **A file to attach or send** (email, Slack, a ticket): call `export_open_design_artifact` with `format: "standalone"`. It writes one self-contained `.html` under the artifact's `exports/` folder, with its local CSS, scripts, images and fonts inlined. Give the user the path, and mention anything it still loads from the internet (such as web fonts). Nothing goes online. Stop here.
|
|
19
|
+
- **A link**: continue below.
|
|
20
|
+
|
|
21
|
+
## 3. Prepare the link
|
|
22
|
+
|
|
23
|
+
Call `publish_open_design_artifact` with the `entryPath`. Pass `provider` only if the user already said where:
|
|
24
|
+
|
|
25
|
+
- `netlify-temporary` or `cloudflare-temporary`: no account, the link lasts about an hour unless claimed
|
|
26
|
+
- `netlify`, `vercel`, `cloudflare-pages` or `github-pages`: the user's own account, a link that lasts
|
|
27
|
+
|
|
28
|
+
Without a provider, the tool returns the choices: show them to the user and call it again with their pick.
|
|
29
|
+
|
|
30
|
+
## 4. Follow the returned instructions exactly
|
|
31
|
+
|
|
32
|
+
They check the host's CLI, then **stop for the user's explicit yes** before anything goes online. That stop is mandatory: say what goes out, who can see it, how long it lasts, and that the small "Made with Open Design" footer badge is included unless they ask for `badge: false`. Deploy only the bundle folder the tool names.
|
|
33
|
+
|
|
34
|
+
## 5. Finish
|
|
35
|
+
|
|
36
|
+
Give the user the link. For a temporary link, also give the claim URL and when it expires, for them only. Then record it by calling `publish_open_design_artifact` again with `published`, as the instructions show, so a later publish updates the same site.
|
|
@@ -15,20 +15,22 @@ If the brief names a platform or format, use it. Otherwise ask the user to pick
|
|
|
15
15
|
|
|
16
16
|
| Format | Canvas | skillId | Export |
|
|
17
17
|
|---|---|---|---|
|
|
18
|
-
| X single image | 1600×900 | `od:prototype:card-twitter` | `
|
|
18
|
+
| X single image | 1600×900 | `od:prototype:card-twitter` | `preset: "x-image"` |
|
|
19
19
|
| X post mock (for a video overlay or quote) | card element | `od:prototype:social-x-post-card` | `selector: "[data-od-card]"`, `maxBytes: 5000000` |
|
|
20
|
-
| Square carousel (Instagram / LinkedIn) | 1080×1080 per card | `od:prototype:social-carousel` | `
|
|
21
|
-
| Instagram portrait | 1080×1350 | `od:prototype:poster-hero` | `
|
|
22
|
-
| Story / Reels / TikTok cover | 1080×1920 | `od:prototype:poster-hero` | `
|
|
23
|
-
| Xiaohongshu cards | 1080×1440 per card | `od:prototype:card-xiaohongshu` | `
|
|
24
|
-
| YouTube thumbnail | 1280×720 | `od:prototype:social-youtube-thumbnail` | `
|
|
20
|
+
| Square carousel (Instagram / LinkedIn) | 1080×1080 per card | `od:prototype:social-carousel` | `preset: "ig-square"` |
|
|
21
|
+
| Instagram portrait | 1080×1350 | `od:prototype:poster-hero` | `preset: "ig-portrait"` |
|
|
22
|
+
| Story / Reels / TikTok cover | 1080×1920 | `od:prototype:poster-hero` | `preset: "story"` |
|
|
23
|
+
| Xiaohongshu cards | 1080×1440 per card | `od:prototype:card-xiaohongshu` | `preset: "xhs-card"` |
|
|
24
|
+
| YouTube thumbnail | 1280×720 | `od:prototype:social-youtube-thumbnail` | `preset: "yt-thumbnail"` |
|
|
25
25
|
| YouTube video | 1920×1080 MP4 | `od:video:hyperframes` | MP4 via the HyperFrames CLI (see step 4) |
|
|
26
26
|
|
|
27
|
+
A preset fills in the canvas size, `selector: "[data-od-card]"` and the platform's upload limit (X 5 MB, Instagram 8 MB, YouTube thumbnail 2 MB).
|
|
28
|
+
|
|
27
29
|
For several platforms at once, run steps 2–4 once per format and keep each one as its own artifact.
|
|
28
30
|
|
|
29
31
|
## 2. Generate
|
|
30
32
|
|
|
31
|
-
Call `prepare_open_design_brief` with the row's `skillId
|
|
33
|
+
Call `prepare_open_design_brief` with the row's `skillId`, the brief, and `format` set to the row's preset id (leave it out for the X post mock and YouTube video). Call `list_open_design_design_systems` first only if the user names a brand or visual direction. For the X post mock, say in the brief that it is one card element.
|
|
32
34
|
|
|
33
35
|
Author the files yourself with your own file-editing tools, following the returned instructions, and add these rules for social posts:
|
|
34
36
|
|
|
@@ -39,11 +41,11 @@ Author the files yourself with your own file-editing tools, following the return
|
|
|
39
41
|
|
|
40
42
|
## 3. Register
|
|
41
43
|
|
|
42
|
-
Call `register_open_design_artifact` with the entry path, kind `html`, a title,
|
|
44
|
+
Call `register_open_design_artifact` with the entry path, kind `html`, a title, `sourceSkillId` set to the row's `skillId`, and the same `format` you passed to the brief, so the export can find the right size.
|
|
43
45
|
|
|
44
46
|
## 4. Export
|
|
45
47
|
|
|
46
|
-
- **Image formats**: call `export_open_design_artifact` with the entry path and the row's export arguments. If it returns warnings (failed fonts or images, over budget), fix the artifact and export again.
|
|
48
|
+
- **Image formats**: call `export_open_design_artifact` with the entry path and the row's export arguments. If its preflight reports errors (text cut off, a card that isn't the canvas size) or it returns warnings (failed fonts or images, over budget), fix the artifact and export again. Before exporting, call `check_open_design_artifact` to see the post as an image with its preflight findings, without writing files; fix every error first.
|
|
47
49
|
- **YouTube video**: follow the brief's "Host override" section. Render with `npx hyperframes render … --output <artifact-dir>/exports/<name>.mp4`, and check `ffmpeg -version` first.
|
|
48
50
|
|
|
49
51
|
## 5. Report
|