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.
1beam login2beam doctor3beam inspect <figma-url>4beam export <figma-url>5beam compare <figma-url> <local-url>6beam snapshots list7beam debug bundle
Run Sequence
- Use auth commands first:
beam login, thenbeam whoamiif you need to verify identity. - Use readiness commands next:
beam doctorbefore live fetches or support debugging. - Use design commands during implementation:
inspect,export, andcompare. - Use local reuse commands after successful fetches:
snapshotsandmappings. - Use support commands last:
debug bundlewhen 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
- ~/.beam/credentials.json
- .beam/cache/
- .beam/mappings.json
- .beam/debug/
Next Step
Open an individual command page from the command grid for exact usage, output, and recovery guidance.
Recovery Paths
- If a CLI command fails, rerun it with
--jsonwhen available to capture structured diagnostics. - If a design command fails, separate auth issues from Figma access issues with
beam doctorandbeam whoami. - If output paths are unclear, use command JSON output instead of scraping terminal text.
beam login
Connect Beam to Figma by storing a user-local credential for the Free workflow.
beam init
Create or print MCP configuration so coding agents can start Beam locally.
beam doctor
Check whether the local machine is ready to use Beam safely and reliably.
beam inspect
Turn a Figma frame into structured implementation context for humans and agents.
beam export
Write local visual references, exportable assets, and the canonical asset manifest.
beam compare
Compare a local rendered page with Figma visual ground truth using practical image signals.
beam snapshots
List, inspect, and restore local snapshots from previous Beam design fetches.
beam mappings
Connect known Figma components to local code imports for better agent handoff.
beam debug bundle
Create a sanitized local support bundle for fetch, cache, simplify, and MCP issues.
beam mcp
Start Beam's MCP server over stdio so coding agents can call Beam tools.
