Skip to main content

kapi context

kapi context [path]

Retrieve the content context this project goes by: the terms, the voice and the rules that hold, without needing to know which store holds the answer.

Two questions, and every asset-shaped lookup is one of them:

kapi context <path> what applies HERE: the voice in force at that location, its guidance, the terms bound there kapi context --profile <n> the same answer for a named profile, when you have no file in hand kapi context search <query> what we know about THIS: terms, prior wording

Communication is contextual: a legal notice is not a help article. Ask what the project says before you write, rather than learning it from a failing check afterwards.

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
FlagTypeDefaultDescription
--filestringexplicit path to resource file
--limitint25max terms to render
--localboolfalseuse resource in current directory
--locale, -lstringnarrow the reported terms to one language
--namestringnamed resource in KAPI_HOME (e.g. --name project-terms)
--profilestringanswer for a named profile instead of a location
--project, -pstringpath to a kapi.yaml project recipe or its directory (auto-discovered from cwd if omitted)
More examples
kapi context docs/guide.md --json
kapi context --profile marketing
kapi context search widget

← Back to the Command Reference