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

brink compile

Compile .ink source files to bytecode. The input file is the story’s entry point; INCLUDE directives are resolved automatically.

brink compile <INPUT> [--output <OUTPUT>]

Options

FlagDefaultDescription
--output <FILE> / -ostdoutOutput file path. Format inferred from extension.

Output format is determined by the file extension:

ExtensionFormat
.inkbBinary bytecode (production format)
.inktHuman-readable text dump (debugging)

When no -o flag is given, .inkt is printed to stdout.

Examples

# Compile to binary
brink compile story.ink -o story.inkb

# Debug dump to file
brink compile story.ink -o story.inkt

# Debug dump to stdout
brink compile story.ink