Getting Started

Getting Started

rmap ships as a single binary that powers training, generation, scanning, and analysis from the terminal. This page walks through installation, tooling basics, and a few commands you can run right away.

Install the CLI

  1. Download the latest release for your platform from github.com/0xchase/rmap/releases.
  2. Extract the archive and move the rmap binary somewhere on your PATH (for example /usr/local/bin on macOS/Linux or a directory referenced by %PATH% on Windows).
  3. Confirm the installation:
rmap --version

Global flags

FlagDescription
-v, --verboseIncrease logging verbosity (stack the flag for more detail).
--profile <NAME>Select a saved profile from $HOME/.config/rmap/profiles/<NAME>.toml.
--log <FILE>Write structured logs to a file while keeping stdout clean.

Global flags must appear before the subcommand, for example rmap -vv --log scan.log scan --path targets.txt icmp.

Common workflows

  • Train a model from seed targets

    rmap train --seeds seeds.txt --output models/6gen.bin six-gen --clusters 24
  • Generate unique IPv6 addresses

    rmap generate --model models/6gen.bin --count 5000 --unique --output targets.txt
  • Probe a target list with ICMP

    rmap scan --path targets.txt --pps 500 icmp --output-file reachability.csv
  • Inspect scan output

    rmap analyze reachability.csv --field target entropy --start-bit 32 --end-bit 64

Every command streams output as it is produced so you can redirect it to files, pipe it into other tools, or monitor it interactively in the terminal.