Commands

mapdiff

mapdiff [CHANGE] [--commit REV | --staged | --pr NUMBER] [--index] [--repo DIR] [--port N] [--no-open]

Opens the map of a repository in the browser, and runs until Ctrl-C.

Argument	Meaning
none	Your uncommitted changes drawn on the map, or the plain map when there are none
CHANGE	REV (against your files as they are), A..B, or A...B (from where B branched off A)
--commit REV	One commit, against the commit before it
--staged	What is staged, against the last commit
--pr NUMBER	A GitHub pull request, fetched from origin
--index	Also run the language indexers in the background. The map opens straight away and gains references when they finish. See languages
--repo DIR	A directory inside the repository. Default: the current one
--port N	Default 7878; the next free port is used when it is taken
--no-open	Print the address without opening the browser

mapdiff serve is the same command, spelled out.

Running servers

Each mapdiff you start is a small server for one repository. It runs until Ctrl-C. These work from any terminal:

Command	Does
mapdiff list	Lists every running server: its repository, its address, the change it last drew, and how long it has been up. --json for a script
mapdiff stop	Stops the server of the repository you are in, the way Ctrl-C does
mapdiff stop --all	Stops every running server
mapdiff clean	Stops every server and removes everything mapdiff has written

$ mapdiff list
REPOSITORY   ADDRESS                SHOWING      UP
~/code/api   http://127.0.0.1:7878  main...HEAD  2h 10m
~/code/site  http://127.0.0.1:7879  uncommitted  14m

mapdiff clean removes, and prints each as it goes:

• review marks and fetched pull requests, in every repository a server was started in and in the one you are in,
• temporary copies of files,
• the cache folder, with its indexes.

Your code is not touched.

In the terminal

Each of these prints what the page shows, most with --json.

Command	Prints
mapdiff diff [CHANGE]	The change as added, removed, modified, renamed and moved scopes
mapdiff diff --scope ID	The before and after of one scope
mapdiff impact [CHANGE]	Unchanged scopes that use something the change altered
mapdiff refs ID	What uses a scope, and what it uses
mapdiff wires [ID] --level LEVEL	The wires among the children of a directory, file or type
mapdiff map --level LEVEL	What a map draws at a level: boxes and wires
mapdiff scopes PATH	The scope tree of a file or directory
mapdiff source ID	The source text of one scope
mapdiff graph	A summary of the reference graph
mapdiff index	Runs the language indexers and waits for them. See languages

ID is a scope’s ID, as the page and mapdiff scopes show it: src/lib.rs::Parser::parse().

Settings

Variable	Does
MAPDIFF_TESTS=1	Reads tests like any other code
MAPDIFF_CACHE_DIR	Where indexes are kept