CLI

The package ships with a small CLI focused on the two most common Python-side operations: serving the viewer and rendering embed HTML.

Installation

python3 -m pip install jsonschema-diagram

After installation:

jsonschema-diagram --help

You can also run it as a module:

python3 -m jsonschema_diagram --help

Command Overview

The CLI currently provides:

• serve

• render-embed

serve

Start the local server for the built site:

jsonschema-diagram serve

Useful options:

• --host: bind host, default 127.0.0.1

• --port: bind port, default 8000

• --static-dir: directory with the built site

• --schema-path: schema served from /api/default-jsonschema

Example:

jsonschema-diagram serve --host 0.0.0.0 --port 9000

render-embed

Render a self-contained embed document to stdout or a file:

jsonschema-diagram render-embed --output diagram.html

Useful options:

• --schema-path: load the schema from a JSON file

• --stdin: read the schema payload from standard input

• --output or -o: output path, or - for stdout

• --theme: default embed theme

• --template-path: custom Jinja2 embed template

Examples

Render from the shared default schema:

jsonschema-diagram render-embed --theme slate --output diagram.html

Render from a specific schema file:

jsonschema-diagram render-embed \
  --schema-path docs/examples/pattern-catalog.json \
  --theme mono \
  --output docs/_build/pattern-catalog.html

Pipe JSON through stdin:

cat schema.json | jsonschema-diagram render-embed --stdin --output diagram.html

Print HTML to stdout:

jsonschema-diagram render-embed --schema-path schema.json --output -

Choosing Between CLI And API

Use the CLI when:

• you are wiring shell scripts

• you want quick local commands

• you are building CI artifacts

• you do not need Python-level control flow

Use the Python API when:

• you need to construct schemas dynamically

• you want tighter integration with another Python application

• you want to keep everything inside a Python build or docs toolchain