The CLI
brink-cli (the brink binary) provides commands for compiling, playing,
localizing, and formatting ink stories.
brink --help
Commands
| Command | Description |
|---|---|
compile | Compile .ink source to .inkb or .inkt |
convert | Convert between ink formats (.inkb, .inkt) |
play | Play an ink story interactively or in batch mode |
debug | Step through a story: breakpoints, stepping, locals, call stack |
ide | Scriptable IDE queries & refactors (navigation, references, rename, structural refactors) |
fix | Apply automatic fixes to a project’s diagnostics to a fixpoint |
export-xliff | Export a story’s line tables as an XLIFF 2.0 file for translation |
compile-locale | Compile a translated XLIFF into a .inkl locale overlay |
regenerate-xliff | Update an XLIFF after recompilation, preserving translations |
fmt | Format .ink source files (--check, --stdin) |
replay | Re-render a saved .brkt transcript against a story (optionally a locale) |