This PR updates the CLI docs to cover several tsci options that were missing or incomplete across the command reference pages.#523
Conversation
…e missing or incomplete across the command reference pages.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
Updates the tsci command reference docs to better reflect supported CLI options, focusing on previously missing or incomplete flags for build, export, and snapshot.
Changes:
- Added and clarified several
tsci buildflags (routing control, PNG/3D output flags, courtyard rendering, KiCad zip export, prop injection). - Documented
--show-courtyardsfortsci exportand added an example invocation. - Expanded
tsci snapshotoption coverage (courtyards, camera presets, CI/test modes, concurrency).
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/command-line/tsci-snapshot.md | Adds missing snapshot flags for courtyards, camera presets, CI/test behavior, and concurrency. |
| docs/command-line/tsci-export.md | Documents courtyard outlines for PCB SVG export and includes an example command. |
| docs/command-line/tsci-build.md | Adds/normalizes build flags for routing, images/3D, KiCad zip export, and prop injection. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - `--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. |
There was a problem hiding this comment.
--ci and --test are described identically (“generate diff artifacts”), which doesn’t explain when a user should choose one vs the other. Please clarify the behavioral difference (or if they’re aliases, document that explicitly).
| - `--test` – enable test mode and generate diff artifacts. | |
| - `--test` – alias for `--ci`; behaves identically and is kept for compatibility. |
| - `--all-images` – generate images for every successful build output. | ||
| - `--pngs` – Generate PNG outputs during build generation`. | ||
| - `--pngs` – generate PNG outputs during build generation. | ||
| - `--pcb-png` – generate PCB PNG outputs during build generation. |
There was a problem hiding this comment.
--pcb-png says it generates “PCB PNG outputs”, but unlike --3d-png it doesn’t specify the exact filename(s) produced (e.g., pcb.png) and whether it’s gated by --preview-images/--all-images or implies --pngs. Adding that detail would make the flag behavior unambiguous.
| - `--pcb-png` – generate PCB PNG outputs during build generation. | |
| - `--pcb-png` – generate PCB PNG outputs named `pcb.png` for each successful build output (subject to the same image/preview selection flags such as `--preview-images`, `--all-images`, or `--pngs`). |
|
Thank you for your contribution! 🎉 PR Rating: ⭐ Track your contributions and see the leaderboard at: tscircuit Contribution Tracker |
Summary
This PR updates the CLI docs to cover several
tscioptions that were missing or incomplete across the command reference pages.What changed
tsci buildflags, including:--routing-disabled--pcb-png--3d-pngand clarified--3das its alias--show-courtyards--kicad-project-zip--inject-props--inject-props-filetsci buildoption descriptions--show-courtyardsfortsci exporttsci snapshotflags, including:--show-courtyards--camera-preset--ci--test--concurrencyWhy
The command reference was missing several supported flags, which made the docs incomplete and harder to trust when using the CLI. This PR brings the docs closer to the actual interface and makes less-common but useful options easier to discover.
Scope
Documentation only. No runtime or algorithmic changes.