Archboard docs
Install Archboard, map a repository with your agent, and hold the map to the code in CI and on every pull request.
On this page
Archboard keeps a model of your architecture next to your code. Your agent writes the model through the CLI. Archboard draws it, checks it against the code, and shows how a change moves it.
Start here#
-
Install and set up
Install the CLI and run
archboard initin a repository. - A first map in one session A first map, three flows and a walkthrough for a newcomer.
- The check as a gate Fail CI, a Git hook or an agent loop when the map and the code disagree.
- Architecture on pull requests Findings on the diff, and the plan against the changed code.
Try it#
npm install --global archboardarchboard initarchboard checkinit makes the vault and installs the skills. Then ask your agent to map the repository. A first map in one session gives the prompts.
See it work#
The relay example is a parcel desk of four services. Its code and its model are in one repository, and its Kubernetes manifests are in another. Clone it to run the gate on your machine, or read its pull requests:
- A change with no plan Intake calls Billing. The check fails, with an annotation on the line.
- The same change with a plan The comment shows the proposal, its changes and the footprint.