TeamAPI latest
On this page
  1. Install
  2. Usage
  3. Exports
  4. The TeamAPI toolchain
  5. License

@jgalego/teamapi-core

npm CI Node License: MIT

$ref resolution, org graph building, cognitive load scoring, DDD context-map derivation, and Mermaid/DOT diagram generation for the Team API as Code extended spec.

This is the shared engine behind the teamapi CLI, the REST API, the MCP server, and the chat tool-use loop — you normally don't depend on it directly unless you're building another adapter on top of the same org graph.

Install#

npm install @jgalego/teamapi-core @jgalego/teamapi-schema

Usage#

import { buildOrgGraph, buildTopologyDiagram, toMermaid } from "@jgalego/teamapi-core";

// seedUris are resolved file paths (expand any globs yourself, e.g. with `fast-glob`)
const graph = await buildOrgGraph({ seedUris: ["./examples/acme-org/stream-checkout/teamapi.yml"] });
console.log(toMermaid(buildTopologyDiagram(graph)));

Exports#

Full docs: https://github.com/JGalego/TeamAPI

The TeamAPI toolchain#

One org graph, seven doors into it — install only the ones you need:

Package What it does
@jgalego/teamapi The CLI — validate, diagram, check, import, reconcile, serve and chat with your org
@jgalego/teamapi-core (this package) The engine: $ref resolution, the org graph, scoring, checks, diagrams, generators
@jgalego/teamapi-schema Zod schemas and TypeScript types for the extended spec
@jgalego/teamapi-rest-api REST API, live dashboard, Swagger UI, Prometheus metrics
@jgalego/teamapi-mcp-server The org graph as MCP tools for LLM assistants
@jgalego/teamapi-chat Chat as a team or member — Anthropic or any OpenAI-compatible endpoint
@jgalego/teamapi-backstage Live Backstage catalog entity provider

Docs, examples and the extended spec: teamapi.dev · github.com/JGalego/TeamAPI

License#

MIT