Gå til hovedinnhold

Keep your writing consistent, and check every edit

A help article, an API reference and a release note should use the same words, whoever writes them. kapi reads the files in your project and holds the rules the project keeps: its terms, its voice, and the suggestions a person decided to keep. You see what applies, decide what becomes a rule, and check every edit. None of it needs linguistic training, and all of it works in a project with one language.

Start a project or use kapi with your agent.

see what applieskapi look · Mapwriteyou or an assistantcheck every editkapi check · Readerdecide what becomes a rulekapi rules · Decide

The writing loop: what you decide becomes a rule that the next look, draft and check all read.

See what applies​

Run kapi init in a folder, or open it in Kapi Desktop with Choose a folder. kapi look prints the project at a glance: its files and blocks, the rules in force, the findings and the suggestions waiting for you. The first look at a project with no rules records what kapi sees in the files as suggestions, such as one word written two ways. In Kapi Desktop this view is the project's Overview.

kapi context <path> prints the rules for one file as an assistant reads them. kapi also writes the rules into a section of AGENTS.md and CLAUDE.md, which an agent loads as it starts, and rewrites it when the rules change. See Context.

Decide what becomes a rule​

A suggestion comes from kapi's first look or from an assistant's kapi context note. Checks report a suggestion and never fail on it. kapi rules asks about each one, with the evidence and the blocks a rule would affect. In Kapi Desktop the same questions are on the Decide page, answered with Keep, Not a rule or Later. A kept suggestion becomes a rule that fails a check; one kept with --advisory only reports.

Word rules live in the terms store. Tone, style measures and pattern rules live in the voice profile, which the recipe binds with defaults.voice. See Growing context.

Check every edit​

kapi check <file> runs the configured checks and prints each finding with its rule id. It exits 3 when a finding fails, so the same command gates CI, and kapi check --ship enforces the project's release policy. kapi fix applies the replacement each failing word-rule finding names, keeps every other byte of the file as it was, and lists the findings that need a rewrite. In Kapi Desktop the Reader shows one file with its findings in place, the rules in the margin, and Fix on each finding kapi can fix.

A passing check means the configured checks met their thresholds; factual accuracy and overall quality need their own review. See Check content like tests and the check reference.

Add languages when you need them​

Add a target language to the recipe when the project needs one. kapi up then translates changed content into each language, reuses earlier translations from the content memory, and holds back what needs a person for review. The language commands appear in kapi --help once the recipe declares a target language. Until then, kapi help languages lists them. See Add languages and the kapi loop.

The engine underneath​

kapi runs on the open neokapi content engine: format readers read each file into blocks, tools and flows process them, and format writers put the edits back with the file's structure kept. Formats differ in what they preserve; the format evidence shows what holds for each. kapi help --all lists every command, including the engine's. See Framework.

Three ways to run it​

The CLI, your agent and Kapi Desktop work on the same kapi project, so a rule kept in one holds in all:

  • Kapi CLI: one binary that operates on files, for scripts and CI.
  • Your agent: kapi connect writes the rules files, the kapi skill and an MCP server entry, so the agent you already use reads the rules and runs the checks. In Kapi Desktop, a project's Assistant section does the same. See Use with your agent.
  • Kapi Desktop: the same project with no YAML and no flags. kapi open opens the folder you are in there. See the Kapi Desktop overview and CLI or Desktop?

kapi share shares the rules and decisions with the people who work on the project, through the repository, a shared folder or an S3 bucket, as the desktop's Share tab does. See Sharing context.

Next​