Docs / Getting started

Installation

The official CLI is published as @google/design.md on npm. Install it globally, as a dev dependency, or use it one-off via npx without any installation.

One-off (no install)

The fastest way to lint a file without adding a dependency:

npx @google/design.md lint DESIGN.md

Dev dependency (recommended for teams)

Add the CLI to your project so the version is pinned and the lint step can run in CI:

npm install --save-dev @google/design.md
# or
pnpm add -D @google/design.md
# or
yarn add -D @google/design.md

Then run it via your package.json scripts:

// package.json
{
  "scripts": {
    "lint:design": "design.md lint DESIGN.md"
  }
}

Global install

npm install -g @google/design.md
design.md lint DESIGN.md

Verify installation

npx @google/design.md --version