Skip to main content

preset badge

Generate design system compliance badge

Reference

Usage

preset badge [options] [path]

Arguments

  • Name
    path
    Type
    optional · default `src`
    Description

    Directory to analyze

Options

  • Name
    -p, --presets \<file>
    Type
    value required
    Description

    Path to presets JSON file (for drift)

  • Name
    --score \<number>
    Type
    value required
    Description

    Use precomputed score instead of scanning

  • Name
    -s, --style \<style>
    Type
    value required · default `flat`
    Description

    Badge style: flat, flat-square, plastic, for-the-badge

  • Name
    -l, --label \<text>
    Type
    value required
    Description

    Custom badge label

  • Name
    -t, --type \<type>
    Type
    value required · default `scan`
    Description

    Score type: drift, scan, compliance

  • Name
    -f, --format \<type>
    Type
    value required · default `svg`
    Description

    Output format: svg, markdown, json, url

  • Name
    -o, --output \<file>
    Type
    value required
    Description

    Output file (default: stdout)

Source

Defined in packages/cli/src/commands/badge.ts.

Was this page helpful?

Last reviewed by @jschuyler