Skip to main content

kapi context observe

kapi observe <what you noticed>

Record something you noticed about how this project writes: a product name as it spells it, a spelling it is consistent about, who its text addresses, the register it keeps.

An observation states no rule. Nothing about a check changes, and nobody has to decide anything about it. It is the material a rule is proposed from later, and recording it costs less than working the same fact out twice.

Say where you saw it with --seen-in and --quote.

Commandcontext observe
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 context observe "the docs address the reader as you"
Flags
FlagTypeDefaultDescription
--project, -pstringpath to a kapi.yaml project recipe or its directory (auto-discovered from cwd if omitted)
--quotestringthe wording you saw
--seen-instringSlicea file you saw it in (repeatable)
More examples
kapi context observe "the product is written Kapi Desktop, never KapiDesktop" \
--seen-in docs/guide.md --quote "Open Kapi Desktop and pick a project."

← Back to the Command Reference