open-reverselab

Installation

On Windows, beginners can double-click START_HERE.bat or START_HERE.cmd from the repository root. It checks Python, uv, Git, workspace layout, and reverse_lab_tools MCP; creates core wrappers; runs real MCP tool calls; gives install advice for missing items; and writes reports/misc/first-run-report.json plus reports/misc/mcp-smoke-report.json.

On macOS/Linux, run ./START_HERE.sh from the repository root. It performs the same first-run checks and uses POSIX shell wrappers under tools/bin/; optional Windows GUI/PE tools are skipped or reported as Windows-only. Platform-specific release artifacts can stay separate: Windows full-toolchain releases ship .bat/PowerShell and GUI tools, while macOS/Linux releases ship the Python, MCP, shell-wrapper, and native CLI paths.

To have an AI Agent perform setup for you, copy the AI install prompt into Codex or Claude Code. If you are not sure where to start, open START.md.

git clone https://github.com/LING71671/open-reverselab.git
cd open-reverselab
python scripts/misc/first_run_check.py       # Check workspace + reverse_lab_tools MCP
uv run --project tools/skills/mcp/ReverseLabToolsMCP python scripts/misc/mcp_smoke_check.py --write-report
.\scripts\misc\bootstrap.ps1              # Core script wrappers (no downloads)
.\scripts\misc\install_tools.ps1 -CTF       # Web tools
.\scripts\misc\install_tools.ps1 -Android   # APK tools
.\scripts\misc\install_tools.ps1 -Windows   # PE tools
.\scripts\misc\install_tools.ps1 -Common    # Ghidra + Maven

macOS/Linux quick start:

./START_HERE.sh
./scripts/misc/bootstrap.sh
export PATH="$PWD/tools/bin:$PWD/tools/ctf-website/bin:$PATH"
python scripts/misc/ai_toolcheck.py --board misc

Agent Quick Start

1. Clone into a stable local directory, for example <workspace>/open-reverselab.
2. Windows: double-click START_HERE.bat or START_HERE.cmd for the first-run check. macOS/Linux: run ./START_HERE.sh.
3. Claude Code: cd <workspace>/open-reverselab before starting the session.
4. Codex APP: open the existing open-reverselab folder directly.
5. AI-assisted setup: copy templates/prompts/ai-install.en.md into your AI Agent.
6. Create a task: python scripts/misc/new_task.py --board ctf-website --name <name>.
7. After moving machines or changing MCP settings, run uv run --project tools/skills/mcp/ReverseLabToolsMCP python scripts/misc/mcp_smoke_check.py --write-report and confirm MCP tool calls pass.

Post-install verification:

python scripts/misc/lab_healthcheck.py
python scripts/misc/ai_toolcheck.py --board misc
python scripts/misc/public_release_check.py

--board misc verifies the fresh-clone core Agent scripts and lightweight tools. Run the full python scripts/misc/ai_toolcheck.py only after installing the Android, Windows, and CTF board toolchains you need.

License

GPL-3.0-only. See LICENSE for details.