Getting Help with Rerius
Repository: https://github.com/ECLS-Studio/rerius
Documentation First#
Before opening an issue or discussion, check the relevant document below:
| Document | Covers |
|---|---|
| README.md | Overview, quick start, feature map |
| BUILDING.md | Build instructions for all platforms |
| CLI_REFERENCE.md | Every CLI flag with examples |
| API.md | Full C API reference |
| js/README.md | JavaScript API and REST server |
| NPM_USAGE.md | Using Rerius as an npm dependency |
| EXAMPLES.md | Common usage recipes |
| FAQ.md | Frequently asked questions |
| ALGORITHMS.md | How CFG, entropy, and RDA work internally |
| TROUBLESHOOTING.md | Build and runtime troubleshooting |
Build Issues#
Most build failures fall into one of these categories:
Missing Node.js headers:
# Debian / Ubuntu
sudo apt install libnode-dev
# Termux: headers are bundled with the nodejs package
pkg install nodejs
# Fedora
sudo dnf install nodejs-devel
isprint undeclared (Clang strict C99):
Fixed in an earlier development build; ensure you are on the latest tagged release. If you still hit this on the latest release, please file a bug: the fix may have regressed.
Linker error: log2 undefined:
# Verify that LDFLAGS in the Makefile includes -lm
grep LDFLAGS Makefile
rerius.node not found after npm install:
# Trigger a manual build
npm run build
# or
bash node_modules/rerius/../build_js.sh
See BUILDING.md and TROUBLESHOOTING.md for full details.
Reporting a Bug#
- Check existing issues to avoid duplicates.
- Confirm the issue is reproducible on the latest
main. - Open a bug report and include: - Rerius version, OS, architecture, and compiler - Reproduction steps - Expected vs. actual output
Security vulnerabilities: do not open a public issue. See SECURITY.md.
Asking a Question#
Use GitHub Discussions for:
- How to use a specific feature
- Understanding CFG, NR, or decompiler output
- Architecture or format support questions
- Integration help (backend services, Express, Fastify, Docker)
Feature Requests#
Open a feature request or start a Discussion. Include the problem you are trying to solve and why it fits within Rerius's scope.