kapi context propose

$ kapi propose <term>

Propose a rule about a word: write this instead of that.

A proposal takes effect at once as advice. Checks report it wherever the word appears, and no check fails on it, so a proposal never stops anyone's work. It starts binding when someone confirms it with "kapi context confirm".

Say where you saw the word with --seen-in. A rule with evidence behind it can be argued with later; a rule without any is a preference somebody typed.

Propose a rule for the voice profile's vocabulary with --list, and one for the project's terms without it.

Commandcontext propose

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 propose utilise --use use

Flags

Flag	Type	Default	Description
--list	string		propose a voice-profile rule in this list instead of a project term: forbidden, competitor or preferred
--note	string		why
--project, -p	string		path to a kapi.yaml project recipe or its directory (auto-discovered from cwd if omitted)
--quote	string		the wording it was seen in
--seen-in	stringSlice		a file the word was seen in (repeatable)
--severity	string		how hard the rule bites once confirmed: minor or neutral report, anything else fails a check
--use	string		what to write instead

More examples

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

$ kapi context propose Ripgrep --use ripgrep --list forbidden --severity major

← Back to the Command Reference