# interagent/prmd

JSON Schema tools and doc generation for HTTP APIs

Repository: https://github.com/interagent/prmd
Canonical: https://ross.abutalabs.com/products/prmd
Language: Ruby
License: MIT
License Family: permissive
Last push: 2025-02-06T16:33:27+00:00

## Health v2 (maintenance only)
Score: 34/100 (v2, computed 2026-09-02T17:46:02.011165+00:00)
- activity 5, release rhythm 35, longevity 100
- inputs: {"age_days": 4640, "days_push": 573, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: no_releases
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 2089, forks 169 (observed 2026-08-28T04:06:12.256807+00:00)

## What it is
Prmd is a Ruby command-line tool for working with JSON Schema descriptions of HTTP APIs. It scaffolds resource schemata, combines and verifies them, and generates Markdown API documentation from the resulting schema.

## Use cases
- generate api documentation from json schema
- scaffold json schema files for api resources
- verify completeness of a json schema api description
- combine multiple schema files into one schema
- convert json schema to markdown docs
- manage api schema definitions in yaml

## When to choose
- you describe your HTTP API with JSON Schema and want automated Markdown docs
- you need to scaffold and validate JSON Schema resource definitions
- you want a scriptable CLI pipeline for schema combine, verify, and doc generation

## When to avoid
- you use OpenAPI/Swagger rather than JSON Schema
- you need a GUI or hosted documentation portal
- your stack is not Ruby-friendly and you prefer Node or Python schema tooling

## Facets
- artifact type: cli-tool
- maturity: maintenance
- function: documentation, api-documentation, parser, cli
- domain: apis, documentation, developer-tools
- platform: cli, ruby
- tags: json-schema, api-docs, ruby-gem, schema-verification, markdown-generation

## Member repositories
- interagent/prmd (main) score 34

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:06:12.256807+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T02:55:38.684761+00:00, confidence not recorded.
  - readme: https://github.com/interagent/prmd (fetched 2026-08-28T04:06:12.256807+00:00, sha bc831b19fe31)
- Data as of 2026-08-30T08:39:29.467469+00:00.