kapi context correct

$ kapi correct <from> <to>

Record that somebody changed wording: what was there, what replaced it, and where.

A correction is evidence about how this project writes, and the cheapest there is, because the judgement has already been made. On its own it records the change and nothing else.

With --propose it also records the rule the change implies, so the next use of the old wording is reported. That rule is a candidate: checks report it and none of them fails on it until someone confirms it.

Commandcontext correct

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 correct "sign in" "log in" --seen-in web/src/auth.tsx

Flags

Flag	Type	Default	Description
--note	string		why
--project , -p	string		path to a kapi.yaml project recipe or its directory (auto-discovered from cwd if omitted)
--propose	bool	false	also record the rule the change implies, as a candidate
--quote	string		the sentence the change was made in
--seen-in	stringSlice		a file the change was made in (repeatable)
--severity	string		how hard that rule bites once confirmed: minor or neutral report, anything else fails a check

More examples

$ kapi context correct utilise use --seen-in docs/guide.md --propose --severity minor

← Back to the Command Reference