materials-cli

# 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`):

```bash
materials render <schema-path> [options]
materials generate "<prompt>" [options]
materials validate <schema-path> [options]
```

### Render

- `materials render schema.json -o output.png`
- Options: `-s, --schema <path>`, `-o, --output <path>` (default `./output.png`), `-f, --format <png|jpg>`, `-w, --width`, `-h, --height`, `--output-schema <path>`, `-i, --interactive`

### Generate (AI)

- `materials generate "A red circle with text Hello" -o out.png`
- Options: `-o, --output`, `-f, --format`, `-w, --width`, `-h, --height`, `--output-schema`, `--model`, `--api-key`, `--base-url`, `-i, --interactive`
- Uses `OPENAI_API_KEY` (and optionally `OPENAI_MODEL`, `OPENAI_BASE_URL`) if not passed via flags.

### Validate

- `materials validate schema.json`
- Options: `-s, --schema <path>`, `-i, --interactive`

## CLI help

```
Usage: materials <command> [options]

Commands:
  render <schema>     Render a JSON schema file to an image
  generate <prompt>   Use AI to generate a schema, then render
  validate <schema>   Validate a schema against the render data schema

Examples:
  materials render schema.json -o output.png
  materials generate "A red circle with text Hello"
  materi...

# Materials CLI

A command-line tool for rendering JSON schemas to images (PNG/JPG) using declare-render. Generate schemas with AI or use your own.

## Installation

```bash
cd materials-cli
npm install
```

### Prerequisites

This tool uses `node-canvas` for rendering. If you encounter installation issues, please refer to the [node-canvas installation guide](https://github.com/Automattic/node-canvas#installation).

#### macOS

```bash
brew install pkg-config cairo pango jpeg giflib librsvg pixman
```

#### Ubuntu/Debian

```bash
sudo apt-get install libcairo2-dev libjpeg-dev libpango1.0-dev libgif-dev librsvg2-dev
```

#### Windows

```bash
npm install --global --production windows-build-tools
```

## Usage

### Render a Schema File

```bash
materials render schema.json -o output.png
```

### Generate with AI

```bash
export OPENAI_API_KEY=your-api-key
materials generate "A red circle with text Hello World" -o output.png
```

### Validate a Schema

```bash
materials validate schema.json
```

## Commands

| Command | Description |
|---------|-------------|
| `render <schema>` | Render a JSON schema file to an image |
| `generate <prompt>` | Use AI to generate a schema, then render |
| `validate <schema>` | Validate a schema against the render data schema |

## Options

| Option | Description |
|--------|-------------|
| `-o, --output <path>` | Output file path (default: ./output.png) |
| `-f, --format <format>` | Output format: png or jpg (default: png) |
| `-w, --width <width>` | Canvas width (default: 800) |
| `-h, --height <height>` | Canvas height (default: 600) |
| `--output-schema <path>` | Save the generated schema to a file |
| `--model <model>` | OpenAI model to use (default: gpt-4o) |
| `-i, --interactive` | Interactive mode for input |

## Environment Variables

You can set environment variables in a `.env` file or export them. The CLI supports:

- `OPENAI_API_KEY` - Your OpenAI API key (required for generate command)
- `OPENAI_BASE_URL` - Custom OpenAI A...