CLI Command
beam inspect
Turn a Figma frame into structured implementation context for humans and agents.
beam inspect is the main Free product workflow. It parses the Figma URL, resolves local auth, fetches frame data through the core Figma client, reads or writes cache entries, creates a snapshot, simplifies the node tree, and returns an implementation brief.
The default context mode is standard, which is designed for agent handoff. It emphasizes layout intent, text, components, tokens, assets, rendered references, warnings, omitted fields, confidence, and build readiness.
Evidence review is enabled by default. Beam should distinguish what came from the Figma node tree, what came from rendered images, what came from local snapshots, what was inferred, and what is missing.
--best-effort must be explicit. If evidence is incomplete, Beam should say whether the agent can proceed, what evidence would improve confidence, and whether the missing data blocks implementation.
1beam inspect <figma-url>2beam inspect <figma-url> --json3beam inspect <figma-url> --best-effort
Run Sequence
- Copy the Figma frame URL, not just the file URL, when possible.
- Run
beam inspect <figma-url>for human-readable context. - Run
beam inspect <figma-url> --jsonwhen an agent, script, or test needs stable structured output. - Review build readiness, warnings, estimated tokens, and clarification requests before implementing.
Expected Output
Beam should return source metadata, snapshot id, frame summary, layout guidance, text and token notes, asset references, warnings, confidence score, build readiness, and local image paths when available.
Files And Artifacts
- .beam/cache/raw/<file-key>/<node-id>.json
- .beam/cache/briefs/<snapshot-id>.json
- .beam/cache/images/<snapshot-id>.png
Next Step
Use the brief to build the UI, then run beam compare <figma-url> <local-url>.
Recovery Paths
- If the URL is invalid, copy a Figma design or file URL that includes a valid file key and node id.
- If access is missing, share the Figma file with the account used by the saved token.
- If Figma is rate limited, use the newest valid snapshot or retry after the reported interval.
