agents-audit monorepo

workspace.json is an open specification for structured AI agent codebase intelligence. A machine-generated JSON file at .agents/workspace.json gives AI coding agents structured context about your repository.

(spec · rendered docs · changelog)

Shipped consumer integrations:

• Buildomator (formerly gsd-plugin) — independent Claude Code implementation reading .agents/workspace.json at SessionStart

This repository is the canonical source for the agents-audit release family.

Packages

Package	Purpose
@workspacejson/spec	JSON Schema and TypeScript types for workspace.json
@workspacejson/rules	Deterministic parser, scanner, validator, and rule engine
agents-audit	CLI for scanning AGENTS.md hygiene and workspace metadata

Spec Source

The canonical specification lives at packages/spec/.

• JSON Schema: packages/spec/schema/v1.json
• TypeScript types: packages/spec/src/types.ts
• Rendered: workspacejson.dev/spec/

Quick Start

# Audit AGENTS.md hygiene in any repo
npx agents-audit

# Generate .agents/workspace.json
npx agents-audit generate

Repository Layout

agents-audit/
├── packages/
│   ├── spec/          — JSON Schema + TypeScript types
│   ├── rules/         — Rule engine and validator
│   └── agents-audit/  — CLI binary
├── .github/
├── pnpm-workspace.yaml
├── package.json
├── README.md
└── CHANGELOG.md

Local Development

pnpm install
pnpm -r typecheck
pnpm -r test
pnpm -r build

To run the CLI against the current repository:

pnpm --filter agents-audit build
node packages/agents-audit/dist/cli.js scan .

Release Notes

Version history is tracked in CHANGELOG.md. GitHub release tags mirror npm package versions.

Support Files

• CONTRIBUTING.md
• SECURITY.md
• AGENTS.md