Materials CLI
Use this skill when the user wants to render JSON schemas to images (PNG/JPG), validate render-data schemas, or generate schemas from natural-language prompts and then render them.
Commands
- - render — Render a JSON schema file to an image.
- generate — Use AI (OpenAI) to generate a schema from a prompt, then render it.
- validate — Validate a JSON schema against the declare-render data schema.
When to use
- - User asks to "render a schema to image", "turn JSON into a picture", or "draw from schema".
- User wants to "generate an image from a description" or "create a schema from a prompt" and render it.
- User wants to "validate" a JSON file against the render data schema.
Usage
Run via Node (from the project or after npm install -g materials-cli):
CODEBLOCK0
Render
- - INLINECODE1
- Options:
-s, --schema <path>, -o, --output <path> (default ./output.png), -f, --format <png|jpg>, -w, --width, -h, --height, --output-schema <path>, INLINECODE9
Generate (AI)
- - INLINECODE10
- Options:
-o, --output, -f, --format, -w, --width, -h, --height, --output-schema, --model, --api-key, --base-url, INLINECODE19 - Uses
OPENAI_API_KEY (and optionally OPENAI_MODEL, OPENAI_BASE_URL) if not passed via flags.
Validate
- - INLINECODE23
- Options:
-s, --schema <path>, INLINECODE25
CLI help
CODEBLOCK1
Schema format
The JSON schema follows the declare-render format: root has id, width, height, and layers. Layer types include text, image, and shape. Use materials validate <file> to check a schema before rendering.
Materials CLI
当用户希望将JSON schema渲染为图像(PNG/JPG)、验证渲染数据schema或根据自然语言提示生成schema并渲染时,使用此技能。
命令
- - render — 将JSON schema文件渲染为图像。
- generate — 使用AI(OpenAI)根据提示生成schema,然后进行渲染。
- validate — 根据declare-render数据schema验证JSON schema。
使用场景
- - 用户要求将schema渲染为图像、将JSON转换为图片或根据schema绘制。
- 用户希望根据描述生成图像或根据提示创建schema并进行渲染。
- 用户希望根据渲染数据schema验证JSON文件。
使用方法
通过Node运行(从项目目录或安装npm install -g materials-cli后):
bash
materials render [options]
materials generate [options]
materials validate [options]
渲染
- - materials render schema.json -o output.png
- 选项:-s, --schema 、-o, --output (默认./output.png)、-f, --format 、-w, --width、-h, --height、--output-schema 、-i, --interactive
生成(AI)
- - materials generate 一个带有文字Hello的红色圆形 -o out.png
- 选项:-o, --output、-f, --format、-w, --width、-h, --height、--output-schema、--model、--api-key、--base-url、-i, --interactive
- 如果未通过标志传递,则使用OPENAIAPIKEY(以及可选的OPENAIMODEL、OPENAIBASE_URL)。
验证
- - materials validate schema.json
- 选项:-s, --schema 、-i, --interactive
CLI帮助
用法: materials [options]
命令:
render 将JSON schema文件渲染为图像
generate 使用AI生成schema,然后进行渲染
validate 根据渲染数据schema验证schema
示例:
materials render schema.json -o output.png
materials generate 一个带有文字Hello的红色圆形
materials validate schema.json
Schema格式
JSON schema遵循declare-render格式:根节点包含id、width、height和layers。图层类型包括文本、图像和形状。在渲染前,使用materials validate 检查schema。