Command line

On Windows the command is routemap-cli.exe (in the Route Map folder); on macOS "/Applications/Route Map.app/Contents/MacOS/routemap-app"; on Linux the AppImage or ./routemap. Examples below say routemap.

routemap                                 open the window
routemap TARGET                          open the window with the trace started
routemap TARGET --json                   trace here, print the route model, exit
routemap TARGET --png map.png --pdf r.pdf
routemap TARGET --origin "Manila, PH"    or --origin 14.6,121.0
routemap parse FILE [--json|--png|--pdf] analyse a trace run elsewhere
routemap sites update [--dry-run]        refresh the carrier site-code table
routemap cache clear                     forget cached Hoiho and IP database answers
routemap --check-update                  ask GitHub for the latest release tag
routemap --version

Options

Option	Meaning
`--json`	print the route model as JSON on stdout
`--envelope`	with `--json`: the full export (trace text, tool, flags) around the route
`--png FILE`	write the map as a 1600x900 PNG
`--pdf FILE`	write the PDF report
`--origin ORIGIN`	where the trace starts: `"lat,lon"` or a city such as `"Manila, PH"`; overrides Settings for this run
`--offline`	contact nothing: only the bundled carrier site codes and local hops

TARGET is a hostname or an IP address. parse FILE reads the output of traceroute, tracert or mtr --report saved to a file. (A Route Map JSON export is reopened in the window with File > Open Trace.)

Progress and the trace tool's own output go to stderr, so --json output on stdout can be piped. Nothing is written anywhere except the files named on the command line and, as in the window, the cache and history in the config folder. Redirected output is UTF-8 on every platform.

Exit codes

Code	Meaning
0	success
1	the trace tool printed nothing, or the trace could not be parsed
2	invalid target, unreadable file or wrong arguments
3	no trace tool found (install `traceroute`, or `mtr`)

Examples

# Trace and keep everything
routemap example.com --json --envelope > example.json --png example.png

# Map a traceroute someone sent you, from their city
routemap parse their-trace.txt --origin "Frankfurt, DE" --pdf report.pdf

# No network at all: placements from carrier site codes only
routemap parse trace.txt --offline --json