> For the complete documentation index, see [llms.txt](https://docs.gomboc.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.gomboc.ai/orl/schemas.md).

# Schemas

ORL files are yaml-like and validated using JSON schema. The `docker run --rm -v ./schema:/workspace gombocai/orl schema` command will render the schema for that version of ORL.

## Schema validation

Most editors that have YAML language server support will validate if you add the following comment to the top of the file:

```yaml
# yaml-language-server: $schema=path/to/orl/schema/ruleset.json
type: Ruleset
version: v1
...
```

Replace `ruleset.json` with the correct type.