Quickstart

Installation

Install DevGraph globally or use npx:

npm install -g devgraph

Using @latest with npx ensures you always get the newest version.

In any .md file (e.g., docs/architecture.md), add devgraph blocks:

## API Service

```devgraph-service
name: api
type: node
commands:
  dev: npm run dev
  build: npm run build
depends:
  - database

service: api
routes:
  GET /health: Health check
  GET /api/users: List users
  POST /api/users: Create user

service: api
vars:
  PORT: "3000"
  DATABASE_URL: postgresql://localhost:5432/mydb

## 2. Build the graph

```bash
devgraph build docs/*.md

Outputs are generated in .devgraph/:

.devgraph/
  |- graph.json
  |- summary.md
  |- agents/
    |- api.md
  |- system.mmd
  |- codemap.mmd

File	Description
`graph.json`	Machine-readable project graph
`summary.md`	Human-readable overview with tables
`agents/*.md`	Per-service context files for LLMs
`system.mmd`	Mermaid diagram of service dependencies
`codemap.mmd`	Mermaid diagram of repo structure

Launch the interactive graph viewer:

devgraph studio