@immediate-diagram/cli

Command-line tool for rendering, validating, previewing, and generating Immediate Diagram .imd files.

Install

bun add -g @immediate-diagram/cli

Note: This package publishes raw .ts source. Requires Bun as runtime.

Commands

imd render

Render an .imd file to SVG or PNG.

imd render input.imd                    # Output SVG to stdout
imd render input.imd -o output.svg      # Write to file
imd render input.imd -o output.png      # Render as PNG (via resvg)
imd render input.imd --state active     # Render a specific state
imd render input.imd --theme dark       # Use dark theme

imd validate

Validate an .imd file (parse + semantic checks).

imd validate input.imd                  # Exit 0 if valid, 1 if errors
imd validate input.imd --recovery       # Show all errors (not just first)

imd preview

Open a live preview in the browser with hot-reload.

imd preview input.imd                   # Open browser preview
imd preview input.imd --port 8080       # Custom port

The preview supports playback controls for diagrams with @timeline: play/pause, step forward/back, scrub, speed control, and loop toggle.

imd generate

Generate a diagram from a natural-language prompt using an LLM.

imd generate "user login flow with email and OAuth"
imd generate "microservice architecture with 3 services" -o arch.imd

Requires ANTHROPIC_API_KEY or OPENAI_API_KEY environment variable.

Examples

# Render a flowchart to SVG
imd render examples/flowchart.imd -o flowchart.svg

# Validate all .imd files in a directory
for f in examples/*.imd; do imd validate "$f"; done

# Preview with live reload
imd preview examples/architecture.imd

# Generate from prompt
imd generate "CI/CD pipeline with build, test, deploy stages"

Development

bun run dev         # Run CLI in dev mode
bun test            # Run tests
bun run typecheck   # Type checking

License

MIT