atmos config schema
Print the embedded JSON Schema for the Atmos CLI configuration (atmos.yaml) — the same
schema atmos validate schema uses for atmos.yaml by default — to stdout, or write it
to a file.
The schema is generated from the Atmos configuration code itself, so it always matches
what the version of Atmos you are running actually reads — including every section,
YAML function alternatives (like logs: !include shared.yaml), and descriptions sourced
from the code documentation. It covers atmos.yaml, atmos.d fragments, and
profile files, none of which require any specific fields,
so partial configuration fragments validate standalone.
Usage
atmos config schema [output-path]
Examples
# Print the schema to stdout.
atmos config schema
# Write the schema to a file, creating parent directories as needed.
atmos config schema website/static/schemas/atmos/atmos-config/1.0/atmos-config.json
Arguments
[output-path](optional)- Write the schema to this file instead of stdout. Parent directories are created as needed.
Editor Integration
Point your editor's YAML language server at the published schema to get auto-completion
and inline validation while editing atmos.yaml:
# yaml-language-server: $schema=https://atmos.tools/schemas/atmos/atmos-config/1.0/atmos-config.json
base_path: "./"
See CLI Configuration Schemas for the floating and version-pinned schema URLs.
