Skip to content

oxo-flow schema#

Output the JSON Schema for the .oxoflow format.

Usage#

oxo-flow schema

Description#

Prints a JSON Schema (Draft-07) document describing the structure and validation rules of .oxoflow workflow files. The schema can be used for IDE validation, automated linting, or integrating oxo-flow into larger toolchains.

Examples#

# Print the schema to stdout
oxo-flow schema

# Save to a file
oxo-flow schema > oxoflow-schema.json

# Validate a workflow against the saved schema (using a JSON Schema
# validator, e.g. check-jsonschema)
oxo-flow schema > schema.json
check-jsonschema --schemafile schema.json workflow.oxoflow

See Also#