buoy begin

An interactive wizard that guides new users through Buoy setup. It runs a scan, shows results, and helps you configure your project step by step.

Usage

buoy begin

What It Does

The wizard walks you through:

  1. Automatic Scan — Scans your project and detects frameworks
  2. Health Overview — Shows component coverage and drift signals
  3. Guided Review — Walk through issues one by one with fix suggestions
  4. Save Configuration — Create a buoy.config.mjs with detected settings
  5. CI Setup — Generate GitHub Actions or GitLab CI config

Example Session

$ buoy begin

Welcome to Buoy

Scanning your project...

━━━ Project Overview ━━━

  Framework: React + Tailwind
  Components: 47 found
  Tokens: 2 file(s) detected

━━━ Health Check ━━━

  ⛁ ⛁ ⛁ ⛁ ⛁ ⛁ ⛁ ⛀ ⛁ ⛁    42/47 aligned (89%)

  Critical:  1
  Warning:   5
  Info:      3

What would you like to do?
❯ Review critical issues (1)
  Review all drift (9)
  Save configuration
  Set up CI integration
  Learn more about Buoy
  Exit

Menu Options

Review Issues

Walk through drift signals one at a time. For each issue you can:

  • Next issue — Move to the next problem
  • Open in editor — Jump to the file in VS Code
  • Mark as intentional — Add a buoy-ignore comment
  • Back to menu — Return to the main menu

Save Configuration

Creates a buoy.config.mjs file with your detected settings. This lets you:

  • Exclude test files and generated code
  • Connect Figma or Storybook as sources of truth
  • Set severity thresholds for CI
  • Track history across your team

Set Up CI Integration

Generates CI configuration for your platform:

  • GitHub Actions — Creates .github/workflows/buoy.yml
  • GitLab CI — Creates .gitlab-ci.yml
  • Manual — Shows the command to add to your pipeline

Non-Interactive Fallback

If you run buoy begin in a non-interactive environment (like CI), it will suggest alternative commands: 

buoy begin requires an interactive terminal.

Try these commands instead:
  buoy status        See health at a glance
  buoy drift check   Detailed drift report

Related Commands