Skip to main content

CLI and REPL

crashlink is invoked as crashlink <file>, either directly or via python -m crashlink. With no subcommand it opens file and drops you into the interactive REPL. Everything else, one-shot subcommands, top-level flags, and REPL commands, is covered below.

Top-level flags​

These apply to the base invocation, crashlink <file> [flags]:

  • -N / --no-constants: skip constant resolution on deserialisation. Useful for malformed or unusually large files.
  • -a / --assemble: treat file as crashlink assembly and assemble it to bytecode instead of opening it.
  • -o / --output: output path for --assemble or --patch.
  • -p / --patch: apply a patch module (a file of patch definitions) to file.
  • -c / --command: run a single REPL command on startup instead of dropping into the interactive prompt (-c '' opens the REPL as usual).
  • -t / --traceback: print full Python tracebacks on error instead of a short message.
  • -d / --debug: enable extra debug output.
  • -D / --no-debug: force debug output off, overriding anything that turned it on implicitly.
  • -C / --dehlc: recover inspection metadata from a compiled HL/C binary; debug information improves recovery but is not required by every recovery path. nasm shows original machine code. Native lift/decomp output is explicitly approximate, with native addresses and ? for unrecovered operands. It is not Haxe decompilation or executable bytecode; bytecode/C export and faithful IR/CFG operations are rejected.
  • --help-all: print the top-level help plus every subcommand's own -h output in one go.

One-shot subcommands​

For anything that doesn't need a live session, there are subcommands that run once and exit. Each has its own -h:

SubcommandDoes
funcsList functions in a bytecode file
disasmDisassemble a function
decompileDecompile a function or class to pseudo-Haxe (decompiler is incomplete, usually functional)
sigBehavioural signature of a function: equal signatures prove equal behaviour (--relaxed, --explain; see Behavioural Signatures)
infoSummary info: version, counts, etc.
searchSearch strings by substring
inlinesFind function bodies the compiler inlined, with their parameter types and per-site constants (--at File.hx:line, --func <findex>)
dbInspect a .cldb debug-info database (db info, db check, db renames, db comments)
hlasmWrite a whole bytecode image as .hlasm source (see Writing HashLink Bytecode by Hand)
projectExport a whole image as a Haxe project that compiles with haxe build.hxml: bodies decompiled, or stubbed with --stubs
hlcTranspile bytecode to C, optionally build it (--build)
mcpRun crashlink as an MCP server
guiLaunch the graphical bytecode inspector
$ crashlink funcs game.hl # list functions
$ crashlink disasm game.hl 42 # disassemble f@42
$ crashlink decompile game.hl 42 # decompile f@42 to pseudo-Haxe
$ crashlink decompile game.hl 17 --class # decompile the class at t@17
$ crashlink decompile game.hl 17 --class --with-deps # ...plus every user class it references
$ crashlink info game.hl # summary info (version, counts, etc.)
$ crashlink search game.hl "password" # search strings by substring
$ crashlink db info game.cldb # inspect a .cldb debug-info database
$ crashlink hlasm game.hl -o game.hlasm # write the image as .hlasm (assemble it back with -a)
$ crashlink hlc game.hl --build # transpile to C and compile it
$ crashlink mcp # run as an MCP server

The REPL​

Running crashlink game.hl with no subcommand loads the file and starts an interactive prompt. Bytecode objects are addressed by index throughout: f@<findex> for functions and natives, t@<tIndex> for types, g@<gIndex> for globals, s@<index> for strings. Command history persists across sessions in ~/.crashlink_history (up/down arrows to browse it), and Tab completes command names. help lists every command with its aliases; help <command> shows a command's usage string and full description.

Command reference​

This isn't exhaustive (there are 60+ commands; run help in a live session for the full current list), but it covers what you'll reach for most:

CommandAliasesDoes
funcs [std]fnsList functions; pass std to include stdlib
fn <idx>fDisassemble a function to opcodes
cfg <idx>Render a control flow graph and open it in the default image viewer
ir <idx>Print a function's IR in object notation
decomp <idx>decompile, dec, pseudo, dDecompile a function to pseudo-Haxe
decompfile <file>dfDecompile every function in a debug source file, grouped by class
stub <file>stubfileEmit a compilable stub of a file (signatures kept, bodies stubbed)
project <folder>Write the whole image as a Haxe project, bodies decompiled (see the project subcommand)
autostub <folder>The same project with every body stubbed: compiles regardless of how bodies decompile
findfunc <query>ffSearch functions by name substring, or list functions in a source file
fnn <name>Print a function by exact name
patch <idx>editEdit a function as .hlasm in $VISUAL/$EDITOR (or a small editor window), then apply it; save writes the result
save <path>Write the modified bytecode out to path
xref <kind> <index> [aux]Cross-references: func, type, field, global, string, or enum
locals <findex>List a function's IR locals with their rename keys
rename <findex> <reg> <def_op|_> <name>Rename an IR local
unrename <findex> <reg> <def_op|_>Clear a local rename
addcomment <findex> <op_idx> <text>Attach a comment to a statement
rmcomment <findex> <op_idx>Remove a comment from a statement
entryPrint the bytecode's entrypoint
typesList all types
objsList all Obj types
obj <tIndex>objectOverview of a class's fields, protos, and bindings
type <tIndex>tDetailed info on a type by index
virt <idx>Print a Virtual type by index
enum <idx>Print an enum type by index
tn <name>Find a type by name
global <gIndex>gShow a global's initialised values
stringsstrsList all strings
floatsList all floats
nativelibslibsList native dynlibs used by the bytecode
infile <file>Find all functions from a given source file
debugfilesList all debug files
inlines [n], inlines at <file:line> [annotate], inlines fn <findex>Inlined function bodies found from debug positions: the most copied ones, one body's shapes (optionally disassembled), or the copies inside one function. Needs a build made with -D keep-inline-positions
source <...>Debug-file/line lookup, in either direction
op <opcode>Print documentation for an opcode
hlc <output path>Transpile the loaded bytecode to C
class <tIndex> [--with-deps]cls, cDecompile an entire class by type index; --with-deps also emits every user class it references
apidocs <path>Generate API documentation for the bytecode's classes
mkdocs <path> [name]mkdocGenerate a MkDocs + Material site for the bytecode's API
shader [name]shadersRecover hxsl shaders embedded in the bytecode
pyreplDrop into a Python REPL with direct access to the Bytecode object
copy <command> [args...]cpRun a command and copy its plain-text output to the clipboard
checkRun basic sanity checks on the loaded bytecode
sha256Print the SHA-256 of the loaded bytecode image
pluginsList discovered plugin optimizers and whether they apply
offset <hex>Print the bytecode section at a given file offset
history [count]histShow recently run REPL commands
clearClear the terminal
wikiOpen the HashLink bytecode wiki page in your browser
exitExit the REPL

A worked session​

$ crashlink game.hl
crashlink> funcs
f@22 static Clazz.main () -> Void (from Clazz.hx)
f@23 Clazz.method (Clazz) -> I32 (from Clazz.hx)
crashlink> findfunc method
f@23 Clazz.method (Clazz) -> I32 (from Clazz.hx)
crashlink> fn 23
f@23 Clazz.method (Clazz) -> I32 (from Clazz.hx)
Reg types:
0. Clazz
1. I32

Ops:
0. Ret {'ret': 1} return
crashlink> decomp 23
function method(this: Clazz): Int {
return 0;
}
crashlink> cfg 23
crashlink> xref func 23
f@22 static Clazz.main () -> Void (from Clazz.hx)
crashlink> rename 23 0 _ localName
crashlink> save game_patched.hl
crashlink> exit

cfg renders the graph with Graphviz and opens it in your system image viewer, so there's no meaningful text output to show. See Getting Started for installing Graphviz if that command errors out.