Skip to content

Document tsci check pcb-style #942

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

Merged
seveibar merged 2 commits into from
Oct 9, 2026
Merged

Document tsci check pcb-style #942

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0f7dc5d
Document tsci check pcb-style with defaults and counted SVG output
seveibar Oct 9, 2026
86c37b9
Keep the check overview general and match existing command reference …
seveibar Oct 9, 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
18 changes: 16 additions & 2 deletions docs/command-line/tsci-check.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: tsci check
description: Partially build and validate circuit artifacts
description: Build and validate circuit artifacts
---

`tsci check` partially builds your circuit and validates specific aspects of the output. It is useful for catching issues early without running a full build.
`tsci check` builds and validates specific aspects of your circuit, such as the netlist, component placement, and routing.

## Usage

Expand Down Expand Up @@ -44,3 +44,17 @@ tsci check routing
:::note
These subcommands are currently under development and may not be fully implemented yet.
:::

### `tsci check pcb-style`

Detect long odd-angle trace runs and unnecessary stair stepping using default rules. Source files are built and routed before analysis.

```bash
tsci check pcb-style [file]
```

- `file` *(optional)* – source entrypoint or prebuilt Circuit JSON; defaults to the project's entrypoint
- `--json` – print the analysis as JSON
- `--svg <file>` – choose the SVG output path (default: `checks/check-pcb-style/pcb.svg`)

Reports the issue count and saves a highlighted SVG overview. Exits with code `1` if style issues are found.
Loading