Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

The CLI

brink-cli (the brink binary) provides commands for compiling, playing, localizing, and formatting ink stories.

brink --help

Commands

CommandDescription
compileCompile .ink source to .inkb or .inkt
convertConvert between ink formats (.ink.json, .inkb, .inkt)
playPlay an ink story interactively or in batch mode
export-xliffExport a story’s line tables as an XLIFF 2.0 file for translation
compile-localeCompile a translated XLIFF into a .inkl locale overlay
regenerate-xliffUpdate an XLIFF after recompilation, preserving translations
fmtFormat .ink source files (--check, --stdin)
replayRe-render a saved .brkt transcript against a story (optionally a locale)