KYAML Syntax Guide

Complete Format Specification and Practical Guide

KYAML Syntax Guide

KYAML uses JSON-compatible flow-style syntax while preserving YAML's comment functionality. This guide covers KYAML syntax rules and best practices in detail.

Basic Syntax

Objects (Maps)

Use curly braces `{}` to represent objects, with key-value pairs separated by commas

{
  "key1": "value1",
  "key2": "value2",
  "nested": {
    "subkey": "subvalue",
  },
}

Arrays (Sequences)

Use square brackets `[]` to represent arrays, with elements separated by commas

{
  "fruits": ["apple", "banana", "orange",],
  "numbers": [1, 2, 3,],
  "mixed": [
    "string",
    42,
    {"nested": "object"},
    ["nested", "array"],
  ],
}

Data Types

Strings

All string values must use double quotes

{
  "simple": "hello world",
  "with_spaces": "hello world",
  "with_quotes": "He said \"Hello\"",
  "multiline": "Line 1\nLine 2\nLine 3",
  "empty": "",
}

Numbers

Numeric types don't need quotes, write directly

{
  "integer": 42,
  "float": 3.14,
  "negative": -10,
  "exponential": 1.23e4,
  "zero": 0,
}

Booleans

Boolean values use `true` and `false`

{
  "is_enabled": true,
  "is_debug": false,
  "feature_flag": true,
}

Related Tools and Resources