Skip to main content

kapi run

kapi run [flow-name] [flags]

Run a composed flow that chains multiple tools together.

Flows are multi-tool pipelines. For single-tool operations, use the tool directly (e.g. "kapi ai-translate" instead of "kapi run ai-translate").

Built-in flows: ai-translate-qa Translate + quality check using AI/LLM

Custom flows can be defined in .kapi project files or .bowrain/flows/ as YAML files.

Use -p to run a flow from a .kapi project file: kapi run translate -p myproject.kapi

Commandrun
Groupprocessing
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 run ai-translate-qa -i app.xliff --target-lang fr
Flags
FlagTypeDefaultDescription
--api-keystringAPI key for the AI provider
--concurrency, -jint0number of files to process at once (0 = auto)
--credentialstringsaved credential name to use (see 'kapi credentials list')
--encoding, -estringUTF-8input file encoding
--explainboolfalseprint the resolved source → sink bindings and exit without running
--format, -fstringoverride input format detection
--input, -istringSliceinput file path(s); repeat for multiple files
--modelstringAI model name
--output, -ostringoutput path or template (e.g. ./out/{name}_{lang}.{ext})
--packboolfalsewhen transforming a .klz, also eject the result to the .klz (auto-pack)
--parallel-blocksint0fan out block processing across N goroutines (0 = off)
--project, -pstringpath to a .kapi project recipe (auto-discovered from cwd if omitted)
--providerstringanthropicAI provider (anthropic, openai, ollama)
--source-langstringensource language (e.g. en, en-US)
--statsboolfalseinclude part/block counts in output
--target-langstringtarget language (e.g. fr, de-DE)
--termbasestringnamed termbase for term-lookup/enforce (resolves from KAPI_HOME)
--tmstringnamed TM for tm-leverage flow (resolves from KAPI_HOME)
--tracestringwrite flow trace JSON to file (for flow visualization)
More examples
kapi run ai-translate-qa -i messages.json --target-lang de

← Back to the Command Reference