Beam logoBeam

Get Started

Install Beam and verify local readiness.

This page covers setup only: runtime requirements, package installation, Figma authentication, and the doctor check that confirms Beam is ready for design work.

The public npm package is usebeam, and the installed command is beam. This keeps the command short while avoiding unavailable npm scopes.

MVP authentication uses a Figma personal access token. OAuth is a later public-v1 direction, but PAT auth keeps the Free product useful while the core design pipeline matures.

After beam doctor passes, this page is complete. Move to First Inspect for the first Figma frame run.

  • Credentials stay in the user Beam directory.
  • Project files should not contain tokens.
  • Use npx usebeam doctor for local project installs.
bash
1npm install -g usebeam2beam login3beam whoami4beam doctor

Run Sequence

  1. Install globally for the simplest personal workflow.
  2. Use project-local installation only when a repository needs a pinned Beam version.
  3. Log in before running live Figma commands.
  4. Run doctor after login and inside the project where Beam artifacts will be written later.
  5. Stop here when doctor passes; the next page owns the first Figma inspect workflow.

Expected Output

beam whoami should confirm a saved local credential without printing the token. beam doctor should show a usable runtime, credential state, cache access, and project readiness.

Files And Artifacts

  1. ~/.beam/credentials.json
  2. .beam/cache/

Next Step

Open First Inspect and run beam inspect <figma-url> against a single Figma frame.

Recovery Paths

  1. If install fails, verify Node.js 22.12 or newer and pnpm/npm availability.
  2. If doctor fails after login, run beam whoami to isolate credential state.
  3. If doctor passes but inspect later fails, treat that as a Figma URL, file access, or rate-limit issue rather than an installation issue.