Getting Started

Synthesized from README.md and docs/BUILDING.md: the facts below match those source files exactly. See Building from Source for every platform.

Rerius ships three ways: a standalone CLI, a C library, and an npm package. All three come from the same C99 core: there is no feature gap between them beyond what's noted in the CLI Reference and JS API pages.

1. Clone and build#

git clone https://github.com/ECLS-Studio/rerius.git
cd Rerius
make

make runs setup.sh, an interactive script for choosing what to build: the CLI binary, the JS addon, or a local copy of the /learn docs. Choose Code to compile the native binary.

2. Run your first analysis#

./rerius -x ./binary

-x runs the standard analysis set: disassembly, symbol resolution, function detection, cross-references, control-flow graphs, loop detection, call graphs, and switch-table detection. For the full pass list, including symbolic execution, the decompiler, and the emulator, see the CLI Reference.

3. Or install via npm: no clone required#

npm install rerius

const rerius = require('rerius');

rerius.withBinary('/path/to/binary', bin => {
    console.log(bin.arch, bin.sha256);
    console.log(bin.sections().length, 'sections');
    console.log(bin.functions().length, 'functions');
});

npm install compiles the native addon as part of the install step: no separate build command needed. TypeScript declarations are included (js/index.d.ts).

4. Android / Termux#

pkg update && pkg install nodejs clang make git
git clone https://github.com/ECLS-Studio/rerius.git
cd Rerius && make

Requirements#

Component	Minimum
C compiler	GCC >= 7 or Clang >= 6
Build system	GNU Make (or gmake on BSD)
External libraries	None
JS addon / npm	Node.js >= 16 with dev headers

Where to go next#

• CLI Reference: every flag, with examples
• Binary Formats: what's actually supported today, including the known ELF32/PE32 gaps
• /learn: a sequential, 69-lesson path from "what is binary analysis" through building your own plugins
• Playground: try it against a sample binary without installing anything