Installation

Buoy can be installed as a dev dependency in your project or run directly with npx.

Using npx (Recommended for trying out)

Run Buoy without installing:

npx @buoy-design/cli audit

This is the fastest way to see what Buoy finds in your codebase.

Installing as a Dev Dependency

For ongoing use, install Buoy in your project:

# npm
npm install --save-dev @buoy-design/cli

# pnpm
pnpm add -D @buoy-design/cli

# yarn
yarn add -D @buoy-design/cli

Then run with npx or add to your package.json scripts:

{
  "scripts": {
    "lint:design": "buoy audit",
    "ci:design": "buoy ci --strict"
  }
}

Global Installation

Install globally to use buoy anywhere:

npm install -g @buoy-design/cli

Requirements

  • Node.js 18 or higher
  • A frontend codebase (React, Vue, Svelte, Angular, or plain CSS)

Verify Installation

$ buoy --version
0.1.0

$ buoy --help
Usage: buoy [command] [options]

Commands:
  init        Initialize Buoy configuration
  scan        Scan for components and tokens
  status      Show design system coverage
  audit       Generate health report
  drift       Detect design drift
  compare     Compare against design tokens
  ci          CI-optimized output
  ...

Next Steps