Skip to main content

preset sync-rules

Write governed design system rules into AI tool ambient instruction files (push-mode)

Reference

Usage

preset sync-rules [options]

Options

  • Name
    -v, --verbose
    Type
    flag
    Description

    Verbose output

  • Name
    --api-key \<key>
    Type
    value required
    Description

    Headless auth: a pk_live_/pk_test_ key (default: OAuth, or PRESET_API_KEY)

  • Name
    --dry-run
    Type
    flag
    Description

    Show what would change without writing

  • Name
    --check
    Type
    flag
    Description

    CI mode: exit non-zero if any block is missing or stale (no writes)

  • Name
    --max-tokens \<n>
    Type
    value required · default `1500`
    Description

    Approximate token budget for the rules block

  • Name
    --include-defaults
    Type
    flag
    Description

    Merge @preset/core default rules when the DB has none

  • Name
    -l, --layer \<id>
    Type
    value required
    Description

    Design system layer UUID to resolve (default: the base layer)

  • Name
    -t, --tool \<tools...>
    Type
    value required · variadic
    Description

    Target tools (claude, cursor, copilot, agents, all). Default: detected files

Source

Defined in packages/cli/src/commands/sync-rules.ts.

Was this page helpful?

Last reviewed by @jschuyler