Installation

Install mediva, run mdv, and wire it into your editor, CI, and coding agent.

Ship's computer: Installation complete. No facehuggers were detected.

Install the CLI

Node.js 20+. The mediva package installs mdv.

npm i -D mediva
pnpm add -D mediva
yarn add -D mediva
bun add -d mediva
npx mdv --help

Add your first contract

# write X.mdv.md beside X.md (starters are being rebuilt)
npx mdv check                # check every document a contract governs

Wire it in

.github/workflows/mdv.yml
on:
  pull_request:
    types: [opened, edited, synchronize, reopened]
jobs:
  mediva:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: jamespacileo/mediva@v0.2.0

Mediva CI · mdv check flags

Introduction

mediva validates Markdown against a contract — verify generated documents the way you verify typed data.

Quickstart

Install mediva, write a contract, validate a file, and fix the first failure — in about five minutes.

On this page

Install the CLIAdd your first contractWire it in