Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 

README.md

workspace-json

workspace-json/agents-audit is the canonical monorepo for this project.

It contains the CLI, the schema and type definitions, the deterministic rule engine, and the release/configuration files that keep the standard grounded in real code.

What this org is

  • The public home for the workspace.json standard is workspacejson.dev
  • The reference implementation lives in the workspace-json/agents- audit monorepo
  • The monorepo is the source of truth for the CLI, schema, rules, docs, and release workflow

What it solves

  • Gives AI coding agents a structured, repo-grounded view of a codebase without requiring them to read everything
  • Makes the repository itself the source of truth for package layout, CI, and release boundaries
  • Keeps the standard anchored in working code instead of marketing copy

What lives here

  • agents-audit provides the reference CLI for scanning AGENTS.md and agents.workspace.json
  • @workspacejson/spec provides the JSON Schema and TypeScript types for agents.workspace.json
  • @workspacejson/rules provides the deterministic engine and supporting rule logic behind the audit
  • The repo also contains docs, tests, packaging, and release configuration

Get started

  • Read the docs at workspacejson.dev
  • Scan a repo with npx agents-audit scan .
  • Generate workspace metadata with npx agents-audit generate .

The packages in this monorepo are versioned and reviewed together so the schema, rules, and CLI stay aligned.