Beam logoBeam

CLI Guide

Human commands stay thin over the core.

The CLI gives users a small set of direct commands for authentication, setup, design inspection, asset export, visual comparison, local reuse, diagnostics, and MCP startup.

beam login stores Figma credentials in the user Beam directory. Tokens are not written into project files or printed back to the terminal.

beam doctor checks the local environment before work begins. It validates Node, auth state, Beam directories, cache access, and project readiness.

beam inspect turns a Figma frame into implementation context. beam export writes visual references and the canonical asset manifest. beam compare checks a local page against Figma ground truth.

beam snapshots supports offline reuse. beam mappings connects known design components to local code. beam debug bundle creates sanitized diagnostics without requiring Beam Cloud.

bash
1beam login2beam doctor3beam inspect <figma-url>4beam export <figma-url>5beam compare <figma-url> <local-url>6beam snapshots list7beam debug bundle

Run Sequence

  1. Use auth commands first: beam login, then beam whoami if you need to verify identity.
  2. Use readiness commands next: beam doctor before live fetches or support debugging.
  3. Use design commands during implementation: inspect, export, and compare.
  4. Use local reuse commands after successful fetches: snapshots and mappings.
  5. Use support commands last: debug bundle when a workflow needs investigation.

Expected Output

Each command should return a clear success state, a next action, and stable paths or JSON fields when artifacts are created.

Files And Artifacts

  1. ~/.beam/credentials.json
  2. .beam/cache/
  3. .beam/mappings.json
  4. .beam/debug/

Next Step

Open an individual command page from the command grid for exact usage, output, and recovery guidance.

Recovery Paths

  1. If a CLI command fails, rerun it with --json when available to capture structured diagnostics.
  2. If a design command fails, separate auth issues from Figma access issues with beam doctor and beam whoami.
  3. If output paths are unclear, use command JSON output instead of scraping terminal text.