Navo

Documentation

Learn Navo quickly

A lightweight docs index for installing Navo, describing architecture in YAML, deploying the SPA, and connecting AI agents. Full guides will live alongside the open-source repository.

Getting started

Install dependencies and open your first architecture map.

Open →

Install Navo

pnpm install, compile config, and run the local app.

Open →

YAML schema

Nodes, groups, edges, links, and metadata fields.

Open →

Compile and validate

Turn system YAMLs into architecture.json with CI checks.

Open →

Docker deployment

Build the SPA image and serve with nginx.

Open →

Static hosting

Publish dist/ to any static file host with SPA fallback.

Open →

Multi-system configuration

Add maps under config/systems and switch in the toolbar.

Open →

Wiki and runbooks

Link markdown docs from service detail into the in-app reader.

Open →

Share and export workflow

Annotate locally, export YAML, and open a pull request.

Open →

MCP server

Connect AI coding agents to your architecture map.

Open →

AI YAML generator

Draft architecture configs with AI assistance.

Open →

Quick start

Clone the repository, install dependencies, compile architecture YAML, and run the local app. Replace the GitHub URL when your public repo is ready.

git clone https://github.com/fremen-labs/navo
cd navo
pnpm install
pnpm run compile:config
pnpm dev

Ready to make your architecture alive?

Join engineers who use Navo to see, share, and evolve their systems.

Try the demoStar on GitHub