Skip to content

Shared Schemas

Canonical type definitions for the CLI agent ergonomics framework. These schemas are implementation-agnostic — they define structure, constraints, and invariants without prescribing a language or library.

Schema JSON Notes Used by
ExitCode exit-code.json exit-code.md REQ-F-001, REQ-C-001, REQ-C-013, REQ-O-041
ExitCodeEntry exit-code-entry.json exit-code-entry.md REQ-C-001, REQ-O-041
ResponseEnvelope response-envelope.json response-envelope.md REQ-F-004, all commands
ManifestResponse manifest-response.json manifest-response.md REQ-O-041
DiagnoseResult diagnose-result.json diagnose-result.md cli-agent-diagnose skill

Using the schemas

Validate your implementation's wire output:

ajv validate -s schemas/response-envelope.json -d output.json

Generate bindings for your language:

# Python
datamodel-codegen --input schemas/ --input-file-type jsonschema --output src/models/

# TypeScript
json2ts --input schemas/ --output src/types/

# Rust
cargo typify schemas/<name>.json > src/types/<name>.rs

# Go
go-jsonschema --package framework schemas/*.json > pkg/framework/types.go

# Java
jsonschema2pojo --source schemas/ --target src/main/java/ --package com.example.framework

See codegen-guide.md for full installation instructions, options, and post-generation validation for each language.

Adding a new type

  1. Create schemas/<name>.json — JSON Schema draft-07.
  2. Create schemas/<name>.md — field table and implementation notes.
  3. Add a row to this index.
  4. Reference <name>.json from the requirement that introduces the type.