Skip to main content

Getting Started - VS Code

Zarf uses the Zarf package schema to define its configuration files. This schema is used to describe package configuration options and enable the validation of configuration files prior to their use in building a Zarf Package.

Adding Schema Validation

  1. Open VS Code.
  2. Install the YAML extension by RedHat.
  3. Open the VS Code command pallete by typing CTRL/CMD + SHIFT + P.
  4. Type Preferences: Open User Settings (JSON)into the search bar to open the settings.json file.
  5. Add the below code to the settings.json config, or modify the existing yaml.schemas object to include the Zarf schema.
  "yaml.schemas": {
"": "zarf.yaml"

When successfully installed, the yaml.schema line will match the color of the other lines within the settings.

Specifying Zarf's Schema Version

To ensure consistent validation of the Zarf schema version in a zarf.yaml file, it can be beneficial to lock it to a specific version. This can be achieved by appending the following statement to the first line of any given zarf.yaml file:

# yaml-language-server: $schema=<VERSION>/zarf.schema.json

In the above example, <VERSION> should be replaced with the specific Zarf release.

Code Example

yaml schema