Skip to main content

kapi brand check

kapi check

Score text against a brand voice profile

Commandbrand check
Try it (demo)

Demo mode — illustrative output from a built-in stub, not a real model. Install the CLI to run with your own API key.

kapi brand check
Flags
FlagTypeDefaultDescription
--aiboolfalseuse an LLM provider in addition to rule-based checks
--api-keystringAPI key for the AI provider
--channelstringapply channel-specific overrides
--credentialstringsaved credential name (see 'kapi credentials list')
--filestringexplicit path to resource file
--input-textstringtext to check (use "-" or omit to read stdin)
--jsonboolfalseoutput results as JSON
--localboolfalseuse resource in current directory
--localestringapply locale-specific overrides
--min-scoreint0fail (non-zero exit) when the score is below this threshold
--namestringnamed resource in KAPI_HOME (e.g. --name project-terms)
--packstringbuilt-in starter pack name
--personastringapply an author persona's overrides (within brand guardrails)
--profilestringbrand voice profile name in the local store
--profile-filestringpath to a standalone profile YAML
--project, -pstringpath to a kapi.yaml project recipe or its directory (auto-discovered from cwd if omitted)
--providerstringAI provider (default: anthropic)

← Back to the Command Reference