Skip to content

Installation and usage

Installation

Pre-compiled binaries

Get pre-compiled binaries for Linux, macOS and Windows from here: https://github.com/ricardoquesada/regenerator2000/releases/latest

From Crates.io

cargo install regenerator2000

From Source

git clone https://github.com/ricardoquesada/regenerator2000.git
cd regenerator2000
cargo install --path .

Quick Start with AI Agents

To quickly start analyzing binaries using an AI agent (such as Antigravity or Claude Code), you can use the regenerator2000-template repository. It comes pre-configured with all the required skills and agent permissions so you can start analyzing and reverse-engineering binaries immediately.

Usage

Start the application with an optional file to load:

regenerator2000 [OPTIONS] [FILE]

Supported file formats

  • .prg: the common Commodore 8-bit program. Files with BASIC stubs automatically have their SYS address parsed for the entry point.
  • .crt: Commodore 64 cartridge files. It parses the CHIP packets and maps them into memory. Supports bank selection.
  • .d64: Commodore 64 disk image files (up to 42 tracks). It allows the user to pick a .prg file from the disk container.
  • .d71: Commodore 64 disk image files (80 tracks, double-sided). It allows the user to pick a .prg file from the disk container.
  • .d81: Commodore 64 disk image files (80 tracks). It allows the user to pick a .prg file from the disk container.
  • .t64: Commodore 64 tape image files. It allows the user to pick a .prg from the container.
  • .vsf: VICE snapshot files. It extracts the 64KB RAM and uses the Program Counter (PC) as the start address.
  • .dis65: 6502bench SourceGen project file.
  • .bin and .raw: pure binary files. The Import Context dialog handles setting the System, Origin, and Entry Point automatically.
  • .regen2000proj: Regenerator 2000 project file

Supported options

  • --help: Displays the help message listing all available options and supported file types.
  • --version: Displays the current version of Regenerator 2000.
  • --import_lbl <PATH>: Import VICE labels from the specified file.
  • --export_lbl <PATH>: Export labels to the specified file (after analysis/import).
  • --export_asm <PATH>: Export assembly to the specified file. Headless mode only accepts .regen2000proj project files.
  • --export_html <PATH>: Export HTML to the specified file. Headless mode only accepts .regen2000proj project files.
  • --assembler <NAME>: Override the assembler format used for export. Valid values: 64tass, acme, ca65, kick. If omitted, the project's saved setting is used.
  • --headless: Run in headless mode (no TUI). Only supports .regen2000proj project files. Mutually exclusive with --mcp-server.
  • --verify: Verify export roundtrip (export → assemble → diff) for all 4 assemblers. Requires --headless (implied automatically). See Assemblers for details.
  • --mcp-server: Run MCP server (HTTP on port 3000). Only supports .regen2000proj project files in headless mode. Mutually exclusive with --headless. See MCP Integration for details.
  • --mcp-server-stdio: Run MCP server via stdio (headless mode).
  • --vice <HOST:PORT>: Auto-connect to the VICE binary monitor at startup (e.g. --vice localhost:6502). See Debugger for details.
  • --dump-system-config-files <PATH>: Dump all built-in system config files (system-*.toml) to the specified directory and exit. The files can then be edited and placed back in the app config directory to override or extend system definitions.
  • --dump-theme-files <PATH>: Dump all built-in theme files (theme-*.toml) to the specified directory and exit. The files can be edited and placed in the config directory to create custom themes. See Custom Themes for details.
  • --dump-enum-files <PATH>: Dump all built-in enum files (enum-*.toml) to the specified directory and exit. The files can be edited and placed in the config directory to create custom enums. See Custom Enums for details.

Note

To ensure the best experience, especially regarding keyboard shortcuts and rendering, we recommend using a modern terminal.

Platform Recommended Terminals
Windows Windows Terminal, Alacritty, WezTerm
macOS iTerm2, Ghostty, Alacritty, kitty, WezTerm
Linux Ghostty, Alacritty, kitty, WezTerm, GNOME Terminal

System Config Files

Regenerator 2000 ships with built-in system definitions for 13 different 6502-based systems. See the Systems page for the full list of supported systems and documentation on creating, overriding, and configuring custom system definitions.

Custom Themes

Regenerator 2000 supports user-created color themes via TOML files. See the Themes page for full documentation on creating, overriding, and configuring custom themes.