gaal schema

gaal schema [flags]

Prints (or writes to a file) the JSON Schema (draft 2020-12) that describes every field of a valid gaal.yaml. Use it for IDE auto-completion, inline validation, and for feeding to LLMs that need the structure.

Flags

Flag	Default	Description
`-f`, `--file <path>`	stdout	Write the schema to a file instead of stdout.

Plus all global flags.

Examples

# Print to stdout
gaal schema

# Write to a file
gaal schema -f schema.json

# Pipe straight into a downstream tool
gaal schema | jq '.properties.repositories'

VS Code integration

The gaal repository ships a workspace settings.json that maps schema.json to every *.gaal.yaml file. Run gaal schema -f schema.json once and YAML auto-completion + inline validation light up automatically. For a standalone project, add this to .vscode/settings.json:

{
  "yaml.schemas": {
    "schema.json": ["gaal.yaml", "*.gaal.yaml"]
  }
}

(Requires the YAML extension by Red Hat.)

JetBrains (GoLand / IntelliJ / PyCharm) integration

Open Settings → Languages & Frameworks → Schemas and DTDs → JSON Schema Mappings.
Click + and add schema.json (or the URL where you host it).
Set the file pattern to gaal.yaml (and any other patterns you use).

Programmatic validation

The schema is the source of truth for what gaal sync accepts. Use it in your own validators, CI checks, or LLM JSON-mode prompts:

gaal schema -f /tmp/gaal.schema.json
ajv validate -s /tmp/gaal.schema.json -d gaal.yaml

CLI reference

gaal schema

Flags

Examples

VS Code integration

JetBrains (GoLand / IntelliJ / PyCharm) integration

Programmatic validation

The gaal.yaml file

Schema reference

​Flags

​Examples

​VS Code integration

​JetBrains (GoLand / IntelliJ / PyCharm) integration

​Programmatic validation

​Related

The gaal.yaml file

Schema reference

Flags

Examples

VS Code integration

JetBrains (GoLand / IntelliJ / PyCharm) integration

Programmatic validation

Related