kapi context

$ kapi context [path]

Ask what this project keeps to before you write a file: the voice, the words to use and to avoid, and what has been suggested but not yet decided.

kapi context <path> what applies to that file kapi context <path> --comments what applies to a comment written in it kapi context --profile <n> the same answer for a named profile kapi context search <word> what the project says about one word

The answer is the text an assistant reads too. --explain adds how it was reached; --json gives all of it as data.

Rules grow out of ordinary work. An assistant notes what it sees and what you change, and each note arrives as a suggestion: checks report it and none fails on it until you keep it. suggest files what kapi can see in the files the same way. Decide about suggestions with review, lay out the whole context with atlas, look up the places a geo axis takes with places, share the context with the rest of the team with sync, and go back to an earlier state with reset.

Commandcontext

Groupwork

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 docs/guide.md

Flags

Flag	Type	Default	Description
--comments	bool	false	answer for the comments in the file rather than its content
--explain	bool	false	add how the answer was reached: point, binding, project, revision and notes
--file	string		explicit path to resource file
--limit	int	25	max word rules to render
--local	bool	false	use resource in current directory
--locale, -l	string		narrow the reported terms to one language
--name	string		named resource in KAPI_HOME (e.g. --name project-terms)
--profile	string		answer for a named profile instead of a location
--project, -p	string		path to a kapi.yaml project recipe or its directory (auto-discovered from cwd if omitted)

More examples

$ kapi context docs/guide.md --explain

$ kapi context cmd/main.go --comments

$ kapi context search widget

$ kapi context suggest

$ kapi context review

$ kapi context atlas

$ kapi context places oslo

$ kapi context sync

← Back to the Command Reference