Skip to main content

kapi exec external-command

kapi external-command [files...]

External Command

Commandexec external-command
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 exec external-command
Flags
FlagTypeDefaultDescription
--apply-sourceboolfalseProcess source text
--apply-targetbooltrueProcess target text
--argsstringSliceCommand arguments; use ${source} and ${target} as placeholders
--commandstringThe command to execute
--concurrency, -jint0max parallel files (0 = auto)
--encoding, -estringcharset the input is read in; a byte-order mark in the file wins (default: the project's defaults.encoding, then UTF-8)
--enginestringformat engine for detected files: native or a plugin name (default: native, then plugins)
--fail-on-unknownboolfalseexit with error if any file cannot be processed (default: skip with warning)
--format, -fstringoverride input format detection
--jsonboolfalseoutput results as JSON
--map, -mstringArraymap glob pattern to format (e.g. '*.docx=okf_openxml:test')
--no-warnboolfalsesuppress warnings for skipped files
--output, -ostringoutput path template (variables: {dir}, {name}, {ext}, {lang})
--output-dirstringwrite outputs under DIR/{lang}/ (default: the target-language file beside the input, mirroring its locale layout; with no target language, the input itself)
--packboolfalsewhen transforming a .kpz, also eject the result to the .kpz (auto-pack)
--parallel-blocksint0fan out block processing across N goroutines (0 = off)
--print-opsboolfalsewrite no file and print the change set the run would apply, for kapi apply
--progressboolfalseshow progress bar
--project, -pstringpath to a kapi.yaml project recipe or its directory (auto-discovered from cwd if omitted)
--send-as-stdinbooltrueSend text via stdin instead of command arguments
--source-langstringsource language (e.g. en, en-US; defaults to the project's source_language, else en)
--strictboolfalsealias for --fail-on-unknown
--target-langstringtarget language (e.g. fr, de-DE); one per run
--target-localestringTarget locale for processing
--timeoutint30Timeout in seconds
--tracestringwrite flow trace JSON to file (for flow visualization)

← Back to the Command Reference