SANNR. Docs / Setup

Private alpha / Getting started

Set up Sannr.

Let your coding agent install Sannr, connect it to your repository, and show you a map of the APIs it finds.

Let your agent install it

Unzip the alpha ZIP, then open your coding agent in the repository where you want to use Sannr. Paste this prompt, replacing [folder path] with the location of the unzipped folder:

Set up Sannr in this repository. The unzipped alpha bundle is at [folder path]. Read INSTALL.txt in that folder and follow it.

The agent checks the bundle, installs it locally, preserves your existing instructions, and reports what it found. Setup does not call your APIs. If something is missing, it will explain the next step.

Finish connecting

Claude Code needs a restart to load the new connection. In Codex, follow the agent’s instructions if a refresh or restart is needed. Accept the project trust prompt if shown, then open a fresh task in the same repository and say:

Finish Sannr setup.

The agent checks that this repository’s installation is active. You do not need to repeat installation or copy any setup details.

See your API map

Your agent should create and open an HTML map during setup. If it hasn’t, ask:

Show me my API map with Sannr. Generate a local HTML page without calling any APIs, and open it for me.

The map shows services, recognized routes, connections, and external API dependencies found in your files. It is a local, offline snapshot; it does not prove that those APIs are running. Regenerate it after changes. If no API surface is found, installation is still complete.

Generate the HTML map from your terminal

To generate it yourself, run this from the repository root, then open api-footprint.html in your browser:

./node_modules/.bin/sannr map . --no-execute --out api-footprint.html

Put it to work

Give the agent a real task, such as “Use Sannr to help me integrate this API.” It can ask for the base URL or authentication when needed and record what it learns for future work.

When you’re done trying it, ask “Prepare Sannr feedback.” Review the report before sending it to the person who invited you.