TeamAPI latest
On this page
  1. 1. Install TeamAPI
  2. 2. Create your organization
  3. 3. Explore a sample organization
  4. Examples

Quick start

1. Install TeamAPI#

Install the CLI from npm:

npm install -g @jgalego/teamapi

Or clone and build from source:

git clone https://github.com/JGalego/TeamAPI.git && cd TeamAPI
pnpm install
pnpm build

2. Create your organization#

Start your own org repository:

teamapi init my-org
cd my-org
teamapi validate      # no arguments needed — teamapi.config.yml says where to look

That writes a teamapi.config.yml, a CI workflow, VS Code settings binding the documents to the published schema, a README, and a first stream-aligned and platform team. Every command in this README then works in that directory with no arguments.

3. Explore a sample organization#

Or try it against the sample org bundled with this repo, examples/acme-org:

teamapi validate examples/acme-org
teamapi render examples/acme-org --scope topology
teamapi serve-api examples/acme-org --port 3000
teamapi serve-mcp examples/acme-org     # point Claude Desktop/Code at this command

Examples covers ACME Org and the other sample orgs, each modeled on a real company's topology.

Examples#

Every example in this README runs against ACME Org (examples/acme-org), a small fictional e-commerce company: Platform Payments runs the payments-api and ledger services everyone else depends on, Stream Checkout owns the cart and checkout flow, Stream Onboarding handles sign-up and KYC, and Enabling DevEx coaches the other three on testing and delivery practices.

Five more fictional-but-recognizable orgs ship alongside it. Four model a real-world team topology; the fifth models a real-world failure mode:

Example Modeled after Shape
examples/reelstream-org Netflix-style streaming platform Full-cycle stream team (Recommendations) + a delivery platform team + a chaos-engineering enabling team
examples/meridian-pay-org Stripe-style payments infrastructure A billing stream team, a ledger/payments platform team, and a complicated-subsystem fraud-scoring team it can't safely absorb
examples/cartwell-org Amazon-style marketplace Two-pizza, single-threaded-owner teams (Search, Fulfillment) plus a seller-enablement team
examples/wavelength-org Spotify-style squads/chapters A playlists squad, an audio-platform team, and a cross-squad chapter-coaching team
examples/driftwood-org An org whose AI outran its org chart Deliberately broken: an orphaned event contract, agents owned by someone who left, a vacant seat two teams report into

They work with every command in this README. Swap in the path, e.g. teamapi render examples/meridian-pay-org --scope topology. Driftwood validates cleanly like the rest but is built to fail teamapi gaps, making it the example for seeing findings from a new check.