Skip to main content
Command Line Interface

tsci snapshot

tsci snapshot renders schematic and PCB SVG images and compares them with saved snapshots. It does not generate 3D snapshots unless you explicitly pass --3d.

Usage​

tsci snapshot [options] [path]

Options​

  • -u, --update – write new snapshots to disk.
  • --force-update – force writing snapshots even when no visual diff is detected.
  • --3d – generate schematic, PCB, and 3D preview snapshots.
  • --pcb-only – generate only PCB snapshots.
  • --schematic-only – generate only schematic snapshots.
  • --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.
  • --ci – enable CI mode and generate diff artifacts.
  • --test – enable test mode and generate diff artifacts.
  • --concurrency <number> – number of files to snapshot in parallel (default: 1).

Arguments​

  • [path] – optional file path, directory, or glob pattern used to limit what gets snapshotted.

Which files are snapped?​

The command searches the current project for:

  • the detected entrypoint (using the same logic as tsci build)
  • any files matching *.board.tsx or *.circuit.tsx

This pattern allows standalone board files (ending in .circuit.tsx) to be tested alongside your main project.

Snapshot location​

Snapshots are stored next to each source file in a __snapshots__ directory. For a file test.board.tsx you will see:

__snapshots__/test.board-pcb.snap.svg
__snapshots__/test.board-schematic.snap.svg

By default, only the PCB and schematic snapshots are produced.

If --3d is specified, the command produces PCB, schematic, and 3D snapshots

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