YAML API

Extensions: .yaml / .yml. The top-level value must be an object. Empty files are skipped with a warning; an unknown extension causes compilation to fail.

Field modifiers

A key suffix determines how the field is written. The parser removes the suffix first to obtain the base field name.

scalar | object | array

Default behavior.

Scalars: overwrite
Objects: merge recursively
Arrays: replace the entire list

array

Insert at the beginning of the target list.

array

Append to the end of the target list.

object

Recursively merge the map while preserving existing target keys.

any

Replace the entire field without merging.

any

Literal field name. Wrapping a key in angle brackets disables modifier-suffix parsing.

List fields such as rules, proxies, and proxy-groups support -start / -end. Object lists whose entries have a name are deduplicated by name; the last entry with the same name is kept.

Order when one field has multiple modifiers

force (stop processing this field if present)
start
Replace with the plain key, or keep the original list
end
merge

Examples

append-rules.yaml

rules-end:
  - DOMAIN-SUFFIX,example.com,DIRECT
  - DOMAIN-SUFFIX,lan,DIRECT

patch-dns.yaml

dns:
  enable: true
  enhanced-mode: fake-ip
  nameserver:
    - https://dns.alidns.com/dns-query

rules-head-tail.yaml

rules-start:
  - DOMAIN-SUFFIX,router.local,DIRECT

rules-end:
  - MATCH,PROXY

hosts-and-dns.yaml

hosts-merge:
  router.local: 192.168.1.1

dns-force:
  enable: true
  nameserver:
    - 1.1.1.1

literal-key.yaml

"<rules-end>": keep-this-key-name

Start here

Overrides

Build

Field modifiers

Order when one field has multiple modifiers

Examples

​Field modifiers

​Order when one field has multiple modifiers

​Examples

Field modifiers

Order when one field has multiple modifiers

Examples