Skip to main content

Usage

augur [flags] <config.yaml | -> [config.yaml | -]...

Flags

FlagDescriptionDefault
-o, --outputOutput format: text, json, githubtext
-s, --strictTreat warnings as errorsfalse
-q, --quietSuppress warnings, show only failuresfalse
-k, --skipComma-separated rule IDs to skip
--no-colorDisable colored outputfalse
-p, --policyAdditional policy directory (merged with built-in rules)

Examples

Lint multiple files:

augur gateway.yaml agent.yaml

Strict mode — warnings become errors:

augur --strict config.yaml

JSON output for programmatic consumption:

augur -o json config.yaml

GitHub Actions annotation output:

augur -o github config.yaml

Skip specific rules:

augur --skip OTEL-015,OTEL-016 config.yaml

Merge in custom policies alongside built-in rules:

augur --policy ./my-policies config.yaml

Read config from stdin:

cat config.yaml | augur -

Mix stdin with file arguments (stdin is read once and merged in position):

augur base.yaml - overrides.yaml < patch.yaml