Skip to main content

kapi brand validate

kapi validate <file.yaml|->

Validate a brand voice profile YAML and report structural problems.

Pass a file path, or "-" to read the profile from stdin. Validation reports:

  • YAML syntax or type errors that stop the profile from parsing
  • unknown fields (typo'd or unsupported keys)
  • missing required fields (only 'name' is required)
  • invalid enum values (tone formality/emotion/humor, style sentence_length/ person_pov/contractions, example category, rule severity)
  • regex in style prohibited_patterns/required_patterns that does not compile
  • vocabulary term rules with an empty term

Exit codes: 0 when the profile is valid, 1 when it has any problem. With --json the result is {"valid": bool, "errors": [{"field", "message"}]}.

Commandbrand validate
Try it

Runs in your browser against a small sample file. Edit the command before running, or press Run to execute it as shown.

kapi brand validate
Flags
FlagTypeDefaultDescription
--colorstringautocolorize output: auto, always, never
--jqstringfilter JSON output through a jq expression (implies --json)
--jsonboolfalseOutput in JSON format
--output-formatstringOutput format: text (alias: table), json, yaml
--textboolfalseOutput in text format (default)

← Back to the Command Reference