tscircuit

You are helping the user design electronics using tscircuit (React/TypeScript) and the tsci CLI.

When this Skill is active:

• Prefer tscircuit’s documented primitives and CLI behavior. If something is unclear, confirm by:
  • Reading local files in the repo (e.g., tscircuit.config.json, index.circuit.tsx, package.json)
  • Running tsci --help or the specific subcommand’s --help
• Avoid “inventing” JSX props or CLI flags.

Default workflow

1. Clarify requirements (if not already given)

• Board form factor / size constraints
• Power sources and voltage rails
• I/O: connectors, headers, mounting holes, mechanical constraints
• Target manufacturer constraints (trace/space, assembly, supplier)

2. Choose a starting point

• If the repo is not a tscircuit project, recommend:
  • Install CLI, then tsci init to bootstrap a project.
• If a form-factor template is appropriate (Arduino Shield, Raspberry Pi HAT, etc.), prefer @tscircuit/common templates.

3. Find and install components

• Use tsci search "<query>" to discover footprints and tscircuit registry packages.
• Use tsci search --digikey "<query>" or tsci search --mouser "<query>" when distributor stock and supplier part numbers matter. Both flags can be combined, and --json provides machine-readable results.
• For USB-C receptacles/connectors, prefer builtin syntax with <connector standard="usb_c" /> instead of importing from JLCPCB.
• Use one of:
  • tsci add <author/pkg> for registry packages (installs @tsci/* packages)
  • tsci import <query> when you need to import a component from JLCPCB or the registry.
• DigiKey and Mouser search results are for part discovery; tsci import does not directly import from those distributors.

4. Write/modify TSX circuit code

• Keep circuits as a default-exported function that returns JSX.
• Read FOOTPRINTS.md before writing custom footprint TSX; prefer a footprinter string when one matches the package.
• Use layout props intentionally:
  • PCB: pcbX, pcbY, pcbRotation, layer
  • Schematic: schX, schY, schRotation, schOrientation
• On large projects (5+ components), use <schematicsection /> to group components by function (e.g. "Power", "MCU", "IO"). This is one of the most important things for schematic readability. Assign each component a schSectionName and manually position all members of a section in close proximity using schX/schY.
• When one large chip needs to appear on multiple schematic sheets, declare the <chip /> once before the sheets, then use one <schematicbox chipRef=".U1" /> per sheet. Either nest each box inside its <schematicsheet />, or keep the elements as siblings and assign the box with schSheetName. Pass only that sheet's labels to the box and keep connections addressed to the original chip, such as U1.VCC. See the <schematicbox /> reference.
• Use <antenna /> for a placed, open-ended PCB antenna. Give it a one-pad footprint, define its local copper geometry with pcbPath, and connect the circuit to its .feed port with a separate <trace />. See the <antenna /> reference.
• Use <trace /> for connectivity; prefer net connections (net.GND, net.VCC, etc.) for power/ground.

5. Build and iterate

• Run tsci check netlist before tsci check schematic-placement, tsci check placement, and tsci build to catch connectivity issues early.
• Use tsci check schematic-placement to validate schematic-side placement before checking PCB placement.
• Do not finalize unless both tsci check schematic-placement and tsci check placement pass with no actionable placement violations; if violations exist, fix layout and rerun until clean.
• Use tsci check trace-length to check for long straight line distances (before routing) or long routes (after routing)
• Run tsci build --pcb-png [file] to inspect placement before checking routing.
• Run tsci check routing-difficulty after placement to identify potential areas of congestion.
• Run tsci build to compile and validate the circuit.
• When routing looks suspicious, run tsci build [file] --autorouter-debug --autorouter-debug-dir dist/autorouter-debug and inspect placement-unrouted.png plus each cumulative phase-N-routed.png. Add --autorouter-dump-srj all when the SimpleRouteJson input and output for every stage is also needed.
• After routing, run tsci check shorts [file] to detect unintended shorts between separate PCB copper groups. Omit [file] to use the project entrypoint; a prebuilt *.circuit.json file is also accepted.
• A detected short makes tsci check shorts exit nonzero. Inspect checks/check-shorts/bitmap.png and checks/check-shorts/pcb.svg, fix the implicated copper, then rerun the check. Do not dismiss this failure as a generic DRC warning.
• The default check analyzes Gerber-derived copper on both layers. Use --mode pcb for PCB geometry, --layer top or --layer bottom to narrow the scope, and --pixels-per-mm <number> only when a different bitmap resolution is needed.
• DRC (Design Rule Check) errors can often be ignored during development—focus on getting the circuit correct first.
• If routing struggles, reduce density, use <group /> for sub-layouts, or change autorouter settings.
• Use tsci dev only when you need interactive visual feedback (not typical for AI-driven iteration).

6. Validate and export

• Run tsci check netlist before tsci check schematic-placement, tsci check placement, and tsci build when preparing to share/publish.
• Run tsci check shorts after routing and before sharing, publishing, or producing fabrication outputs. Resolve every reported short before proceeding.
• Run tsci build (and optionally tsci snapshot) before sharing/publishing.
• Use tsci export for SVG/netlist/DSN/3D/library outputs.
• For manufacturing, obtain fabrication outputs (Gerbers/BOM/PnP) from the export UI after tsci dev.

Safety and non-goals

• Treat electrical safety, regulatory compliance, and manufacturability as user-owned responsibilities.
• Do not publish (tsci push) or place orders unless the user explicitly requests it.

Local references bundled with this Skill

• CLI primer: CLI.md
• Syntax primer: SYNTAX.md
• Workflow patterns: WORKFLOW.md
• Pre-export checklist: CHECKLIST.md
• Ready-to-copy templates: templates/
• Helper scripts: scripts/

Builtin Elements

• <analogsimulation />
• <antenna />
• <assembly.device />
• <battery />
• <board />
• <breakout />
• <breakoutpoint />
• <cadassembly />
• <cadmodel />
• <capacitor />
• <chip />
• <connector />
• <constraint />
• <copperpour />
• <coppertext />
• <courtyardcircle />
• <courtyardoutline />
• <courtyardpill />
• <courtyardrect />
• <crystal />
• <currentsource />
• <cutout />
• <diode />
• <enclosure.cutoutaperture />
• <enclosure.fdm.box />
• <fabricationnotedimension />
• <fabricationnotepath />
• <fabricationnoterect />
• <fabricationnotetext />
• <fiducial />
• <footprint />
• <fuse />
• <group />
• <hole />
• <inductor />
• <jumper />
• <led />
• <mosfet />
• <mountedboard />
• <net />
• <netalias />
• <netlabel />
• <opamp />
• <panel />
• <pcbkeepout />
• <pcbnotedimension />
• <pcbnoteline />
• <pcbnotepath />
• <pcbnoterect />
• <pcbnotetext />
• <pcbtrace />
• <pinheader />
• <pinout />
• <platedhole />
• <port />
• <potentiometer />
• <pushbutton />
• <resistor />
• <resonator />
• <schematicarc />
• <schematicbox />
• <schematiccell />
• <schematiccircle />
• <schematicline />
• <schematicpath />
• <schematicrect />
• <schematicrow />
• <schematicsection />
• <schematictable />
• <schematictext />
• <silkscreencircle />
• <silkscreenline />
• <silkscreenpath />
• <silkscreenrect />
• <silkscreentext />
• <smtpad />
• <solderjumper />
• <subcircuit />
• <subpanel />
• <switch />
• <symbol />
• <testpoint />
• <trace />
• <tracehint />
• <transistor />
• <via />
• <voltageprobe />
• <voltagesource />