Command Reference
Every command in the kapi CLI, generated from the binary so the flags and synopses match the version you have installed. Select a command to read its description, flags, and examples. Commands that run entirely in the browser carry a Run button that executes them against a small sample file. AI and MT commands carry a Demo badge and run via a built-in stub — the output is illustrative, not from a real model. Commands that need network access, an API key, or local system access point to a walkthrough instead. Each command has a shareable link.
133 of 133 commands
advanced
configRunGet or set kapi configuration (app config subcommands, recipe keys positionally)1 flagexecRunExecute one registry tool on files (the raw layer under the porcelain verbs)extractRunEmit a bilingual file for a translator — native .kpz or XLIFF/PO15 flagsflowsRunList available flowsformatsRunList supported file formats2 flagsinfoRunReport a project's packable state, or a .kpz archive's contents6 flagsinspectRunParse any format into anchored, structured content blocks5 flagsmcpWatchStart MCP server (stdio) exposing the project's context and the loop around it3 flagsmergeRunApply a returned bilingual file (.kpz/XLIFF/PO) back onto the project source6 flagspackRunSnapshot a kapi project's working state into a .kpz9 flagspluginWatchInstall and manage manifest-driven plugins (#438)pluginsrunRunRun a composed flow (a named multi-tool pipeline)23 flagsstatsRunSummarize content metrics for files — blocks, words, characters, segments, by role3 flagstoolsRunList available processing toolsunpackRunRehydrate a project's working state from a .kpz snapshot6 flags
assets
translate
work
addRunAdd file patterns to the project's content7 flagsapplyRunApply a typed change-set (content + asset edits) — the one write verb6 flagscheckRunVerify content against a checkset and gate on severity, like tests over code25 flagscontextRunAsk what this project's content context saysinitRunScaffold a new kapi project in the current directory7 flagslsRunList the files the project's content tracks7 flagsrmRunRemove file patterns from the project's content6 flagsstatusRunShow per-locale translation coverage and ship-gate standing7 flagsupRunBring the project up to date (run the default flow until every gated scope ships or parks)32 flags
Other
brand checkDemoScore text against a brand voice profile17 flagsbrand guideRunPrint the brand voice guide (inject into your assistant's context)15 flagsbrand importRunImport a profile YAML into the local brand store8 flagsbrand newRunScaffold a brand voice profile YAML to fill in (optionally seeded from a starter pack)2 flagsbrand packRunInstall a built-in starter pack into the local brand store8 flagsbrand profilesRunList brand voice profiles (local store + built-in packs)8 flagsbrand rewriteDemoSubstitute forbidden/competitor terms for their approved wording (offline)12 flagsbrand showRunShow a brand voice profile as a guide15 flagsbrand validateRunValidate a brand voice profile YAML (structure, enums, regex, terms)5 flagscompletionRunGenerate shell completion scriptconfig getRunPrint a single config value5 flagsconfig listRunList every configured value, including plugin namespaces5 flagsconfig pathRunPrint the config file path (of kapi, or of a plugin namespace)5 flagsconfig setRunSet a config value (persists to the global config file, or a plugin's when the key is namespaced)5 flagsconfig unsetRunRemove a config value, restoring the built-in default5 flagscontext searchRunAsk what the project's context says about a word or phrase5 flagscredentials addWatchSave a named AI provider credential4 flagscredentials listWatchList saved credentialscredentials removeWatchRemove a saved credentialcredentials testWatchTest that a credential's API key is accessibleexec brand-voice-checkDemoCheck text against a brand voice profile using an LLM provider19 flagsexec brand-voice-inferDemoInfer a draft brand voice profile from a content corpus using an LLM provider21 flagsexec case-transformRunCase Transform19 flagsexec create-targetRunCreate Target20 flagsexec diff-leverageRunDiff Leverage18 flagsexec dnt-checkRunDo-Not-Translate Checkdnt16 flagsexec encoding-detectRunEncoding Detect14 flagsexec entity-extractDemoDetect named entities (people, organizations, products, locations) with an LLM, a local NER model, or both23 flagsexec external-commandRunExternal Command23 flagsexec inline-codes-removeRunInline Codes Remove21 flagsexec media-refineDemoRe-read low-confidence OCR/ASR lines with a configurable multimodal LLM21 flagsexec placeholder-checkRunPlaceholder Check15 flagsexec pseudo-translateRunPseudo Translatepseudo19 flagsexec qaDemoCheck translation quality with deterministic rules or an LLM (select with --mode)57 flagsexec recycleRunRecycle25 flagsexec redactRunReplace sensitive spans with protected placeholders before processing20 flagsexec remove-targetRunRemove Target20 flagsexec reviewDemoReview translations with scoring using an LLM provider20 flagsexec scriptRunScript20 flagsexec search-replaceRunSearch and Replace23 flagsexec segmentationDemoSplit source text into sentence or chunk segments (stand-off overlay)segment31 flagsexec source-gateRunSource Gate15 flagsexec term-checkRunTerminology Check16 flagsexec term-extractDemoExtract candidate terminology from content using an LLM provider19 flagsexec translateDemoTranslate content with an LLM or machine-translation provider (select an engine, then a provider)27 flagsexec unredactRunRestore original values into redacted content after processing16 flagsexec whitespace-correctRunWhitespace Correct28 flagsexec xml-validationRunXML Validation18 flagsflows listRunList available flowsformats infoRunShow detailed information about a formatformats schemaRunOutput JSON Schema for a formatmemory auditRunTrace content-memory entries by merge batch id5 flagsmemory exportRunExport content memory to TMX or a native .memory.json bundle6 flagsmemory importRunImport a TMX file or a native .memory.json bundle into content memory8 flagsmemory import-dirRunImport all TMX files from a directory into content memory9 flagsmemory listRunList named Memories in KAPI_HOMEmemory lookupRunLook up text in content memory7 flagsmemory searchRunSearch content memory entries6 flagsmemory sessionsRunManage TMX import sessionsmemory sessions deleteRunRemove a session record (entries are retained, session_id cleared)3 flagsmemory sessions listRunList all import sessions3 flagsmemory sessions showRunShow details for a single import session3 flagsmemory statsRunShow content memory statistics3 flagsmodels defaultWatchShow or set the default AI model (and its provider)6 flagsmodels listWatchList every model kapi can use (Ollama, plugin assets, cloud providers)1 flagmodels ollamaWatchManage the local Ollama runtime for on-device translationmodels ollama installWatchPrint how to install the Ollama runtime (or install it on macOS with --run)1 flagmodels ollama listWatchList models installed on the Ollama servermodels ollama pullWatchDownload a model onto the Ollama servermodels ollama statusWatchShow whether the Ollama runtime is installed, running, and which models are presentmodels pruneWatchRemove a model (Ollama model, or a cached plugin asset)models pullWatchDownload a model (Ollama model, or a plugin asset)models setupWatchInteractively pick and verify the default AI providerplugin doctorWatchRun health/self-checks on installed pluginsplugin infoWatchShow details for an installed pluginplugin installWatchInstall a plugin from the registry3 flagsplugin listWatchList installed pluginsplugin pruneWatchRemove retired plugins that are still installed2 flagsplugin rebuild-cacheWatchForce a rebuild of the plugin dispatch cacheplugin registryWatchManage plugin registriesplugin registry addWatchAdd a registry to global config1 flagplugin registry listWatchList configured registriesplugin registry removeWatchRemove a registry from global configplugin removeWatchRemove an installed pluginplugin searchWatchSearch the registry for plugins1 flagplugin updateWatchUpdate an installed plugin to the latest matching version4 flagsplugin update-indexWatchRefresh the cached registry index1 flagplugin verifyWatchRe-verify an installed plugin's manifest and binarytelemetryWatchShow or change anonymous usage telemetry (status, on, off)telemetry offWatchDisable anonymous usage telemetry (persists to the global config file)telemetry onWatchEnable anonymous usage telemetry (persists to the global config file)telemetry statusWatchShow whether telemetry is enabled, why, and the exact payload shapeterms exportRunExport terms to CSV, JSON, TBX, or a native .terms.json bundle8 flagsterms importRunImport terms from CSV, JSON, TBX, or a native .terms.json bundle10 flagsterms listRunList named terms stores in KAPI_HOMEterms lookupRunLook up a term in the terms store7 flagsterms searchRunSearch concepts in the terms store6 flagsterms statsRunShow terms statistics3 flagstools listRunList available processing toolstools schemaRunPrint the JSON Schema for a tool's parametersupdateWatchUpdate kapi to the latest release3 flagsversionRunShow version information