Skip to content

Document tsci snapshot --simulation-only and --layer flags; correct 3D snapshot file extension#765

Open
rushabhcodes wants to merge 2 commits into
tscircuit:mainfrom
rushabhcodes:docs/tsci-snapshot-simulation-layer-options
Open

Document tsci snapshot --simulation-only and --layer flags; correct 3D snapshot file extension#765
rushabhcodes wants to merge 2 commits into
tscircuit:mainfrom
rushabhcodes:docs/tsci-snapshot-simulation-layer-options

Conversation

@rushabhcodes

Copy link
Copy Markdown
Contributor

Updates the tsci snapshot command reference to match the current CLI.

Changes

  • Document the --simulation-only flag, including its mutual-exclusivity with --pcb-only, --schematic-only, --layer, --3d, and --camera-preset.
  • Document the --layer <top|bottom> flag (implies --pcb-only).
  • Correct the 3D snapshot output extension from .snap.svg to .snap.png (the CLI writes a binary PNG).
  • Add *.circuit.json to the list of file patterns the command snapshots.
  • Document the simulation snapshot output filenames (-simulation.snap.svg, -schematic-simulation.snap.svg) and per-layer PCB filenames (-top.snap.svg / -bottom.snap.svg).

Verification

Option names, flag constraints, file patterns, and output filenames were cross-checked against the CLI source (cli/snapshot/register.ts, lib/shared/process-snapshot-file.ts, lib/shared/find-board-files.ts) and the CLI's snapshot test suite.

@vercel

vercel Bot commented Jun 25, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Jun 26, 2026 12:31pm

Request Review

Comment thread docs/command-line/tsci-snapshot.md Outdated
Comment thread docs/command-line/tsci-snapshot.md Outdated
Comment thread docs/command-line/tsci-snapshot.md Outdated
@github-actions

Copy link
Copy Markdown

This PR has been automatically marked as stale because it has had no recent activity. It will be closed if no further activity occurs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants