Skip to content

Document tsci snapshot view flags (--schematic-only, --simulation-only, --layer, camera presets) - #32

Open
rushabhcodes wants to merge 1 commit into
tscircuit:mainfrom
rushabhcodes:docs/tsci-snapshot-view-flags
Open

Document tsci snapshot view flags (--schematic-only, --simulation-only, --layer, camera presets)#32
rushabhcodes wants to merge 1 commit into
tscircuit:mainfrom
rushabhcodes:docs/tsci-snapshot-view-flags

Conversation

@rushabhcodes

Copy link
Copy Markdown
Contributor

What

Expands the tsci snapshot section of the skill docs to cover the snapshot options that were previously undocumented. Until now the CLI reference only mentioned --pcb-only, --3d, and --test, so the other views and flags were undiscoverable.

Added to CLI.md

  • Snapshot types: --schematic-only, --simulation-only, and --layer top|bottom alongside the existing --pcb-only / --3d.
  • Useful options: --camera-preset <preset> (with the full preset list), --show-courtyards, -u/--update & --force-update, --disable-parts-engine, the path glob argument, and --concurrency <n>.
  • Updated the lead description and the recommended-pattern snippet to surface the single-view commands.

Added to WORKFLOW.md

  • A note pointing to --schematic-only / --simulation-only and the --3d + --camera-preset 3D preview.

Why

These flags are all real (tsci snapshot --help), but absent from the docs the agent defaults to full snapshots even when one view is wanted. Documenting them lets it pick the cheapest correct view (e.g. --schematic-only during wiring, --layer for a single copper layer) and use 3D camera presets deliberately.

Verification

Every flag listed was cross-checked against tsci snapshot --help on the installed CLI; no behavior changes, docs only.

…y, --layer, camera presets)

Expand the tsci snapshot section of the skill docs to cover snapshot options
that were previously undocumented. The CLI reference only mentioned --pcb-only,
--3d, and --test, so the other views and flags were undiscoverable.

CLI.md:
- Snapshot types: --schematic-only, --simulation-only, --layer top|bottom
- Useful options: --camera-preset (with preset list), --show-courtyards,
  -u/--update & --force-update, --disable-parts-engine, path glob, --concurrency
- Surface single-view commands in the recommended-pattern snippet

WORKFLOW.md:
- Note pointing to --schematic-only / --simulation-only and --3d + --camera-preset

All flags cross-checked against tsci snapshot --help; docs only, no behavior change.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant