Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rushabhcodes wants to merge 2 commits into
base: main
Choose a base branch
from
+3 −1
Open

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d7c042e
Document tsci snapshot --simulation-only and --layer flags; correct 3…
rushabhcodes Jun 25, 2026
7f2e10b
up
rushabhcodes Jun 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/command-line/tsci-snapshot.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ tsci snapshot [options] [path]
- `--3d` – also generate 3D preview snapshots.
- `--pcb-only` – generate only PCB snapshots.
- `--schematic-only` – generate only schematic snapshots.
- `--simulation-only` – generate only simulation snapshots.
- `--layer <layer>` – generate a PCB snapshot for a single layer, either `top` or `bottom`.
- `--disable-parts-engine` – disable the parts engine while rendering snapshots.
- `--show-courtyards` – show courtyard outlines in PCB snapshots.
- `--camera-preset <preset>` – choose the camera angle preset for 3D snapshots. This also implies `--3d`.
Expand All @@ -42,6 +44,6 @@ __snapshots__/test.board-pcb.snap.svg
__snapshots__/test.board-schematic.snap.svg
```

If `--3d` is specified, a `-3d.snap.svg` is also produced.
If `--3d` is specified, a `-3d.snap.png` is also produced.

Running without `--update` verifies that the generated output matches the existing snapshots. Differences cause a non-zero exit code.
Loading