Skip to content

Configuration Schema

The ifstatecli command uses a config file based on Yaml and must comply to the provided JSON Schema. It is possible to include values from external files (i.e. private keys) using the provided !include tag.

A schema description and the JSON schema file for this version can be found here:

The schema is also available in the JSON Schema Store (as ifstate.conf). Most modern editors and IDEs have native support for the JSON Schema Store.

Adding the following line to the configuration file instructs editors and IDEs using the YAML Language Server to load the IfState schema automatically. The schema is versioned and available for the latest major and major.minor releases:

# yaml-language-server: $schema=https://ifstate.net/schema/2.0/ifstate.conf.schema.json