Docs

systemap docs

The guide tells you how to make a map, read it, and update it after a change. The reference gives each rule, command, and setting.

Guide

• 1Get startedThis page tells you how to install systemap and make the first map of a small Python project with a coding agent.
• 2ConceptsThis page gives the terms of a systemap map and their meanings in this project.
• 3Read the mapThe page that systemap renders shows the map in three views: Map, Sequences, and Changes. This page gives the controls and the keys of each view.
• 4Coding agentsA coding agent writes the map with the systemap skill. The Claude Code plugin supplies the skill and a live map above the prompt.
• 5Pull requests and CIThe workflow from systemap init compares the map with the source in CI. On a pull request, systemap delta gives the map changes.
• 6The live mapsystemap live renders the map of the working tree and supplies it on 127.0.0.1. It renders the map again after each change.
• 7Trust and securityThis page tells what systemap reads, runs, sends, and writes. Read it before you run systemap on a repository that another person controls.
• 8LimitsA map without open findings agrees with the mechanical rules of systemap. It does not prove that each claim is correct.

Reference

• ReferenceThis page gives the rules of each check, each command, and each setting.
• BenchmarksThis page gives the recorded runs of the map procedure and their costs.