Skip to content

Filtering Options

Filtering options give each run of a subcommand (enum, export, struct) its own view of the input data.

All filtering options are applicable to all data types.

Option Description
xflags Scenario flags to control field inclusion, evaluated against --xflags / -x View
tags General-purpose flags to control field inclusion and exclusion, evaluated against --tags and --tags-xx View
minver Minimum semantic version required (e.g. minver=1.2.0) for field inclusion, compared against --semver View
Brace flags Name suffix in curly braces (such as {en}) to define field variants, evaluated against --brace-flags / -b View

The xflags option marks a field with flags for specific scenarios. These flags are evaluated against the --xflags CLI flag to determine field inclusion.

Flags are comma-separated and case-insensitive:

xflags=c
xflags=c,s
xflags=c,s,steam

When xflags are evaluated against --xflags, a field is excluded only when its xflags explicitly fail to satisfy --xflags. A ++ prefix overrides this: a field is included only when its xflags explicitly satisfy --xflags.

--xflags not set --xflags match
(e.g. c)
--xflags mismatch
(e.g. z)
xflags not set included included included
xflags=c,s included included excluded
xflags=++c,s excluded included excluded

The tags option marks a field with flags for general purpose. These flags are evaluated against the --tags and --tags-xx CLI flags to determine field inclusion and exclusion.

Flags are comma-separated and case-insensitive:

tags=play,editor
tags=++play
--tags not set --tags match
(e.g. play)
--tags mismatch
(e.g. design)
tags not set included included included
tags=play,editor included included excluded
tags=++play,editor excluded included excluded

The minver option sets the minimum semantic version required to include a field. Archmage compares the value against the --semver CLI flag, including the field if --semver >= minver.

minver=1.2.3

The version format follows Semantic Versioning.

Brace flags aren’t really an option. See Brace Flags for details.