User-Facing Tools
tscircuit is a set of tools around the same circuit-as-code workflow. You can start in the online editor, move to local development with the CLI, and use previewers, converters, and web APIs when you need to integrate tscircuit into a larger toolchain.
Design and Editing
| Tool | Use it for | Where to start |
|---|---|---|
| tscircuit.com editor | Writing and previewing tscircuit projects in the browser | Quickstart: web editor |
| tsci CLI | Creating, developing, building, and exporting projects locally | Quickstart: CLI |
| RunFrame | Embedding a live tscircuit runner inside another web page | Run tscircuit in an iframe |
Preview and Inspection
| Tool | Use it for | Where to start |
|---|---|---|
| PCB viewer | Rendering and inspecting PCB layouts from Circuit JSON | Display Circuit JSON on a webpage |
| 3D viewer | Showing board assemblies with 3D component models | Cad model element |
| Circuit preview component | Showing schematic, PCB, pinout, and 3D previews in docs or apps | Programmatically building circuits |
Conversion and Importing
| Tool | Use it for | Where to start |
|---|---|---|
| JLCPCB import | Turning JLCPCB parts into tscircuit components | Importing from JLCPCB |
| KiCad import | Reusing KiCad libraries and symbols in tscircuit projects | Importing from KiCad |
| Circuit JSON import | Converting existing Circuit JSON into reusable tscircuit code | Importing from Circuit JSON |
Routing, Exporting, and Ordering
| Tool | Use it for | Where to start |
|---|---|---|
| Autorouting API | Routing PCB traces from Circuit JSON in automated workflows | Autorouting API |
| Export commands | Exporting fabrication files, images, and project outputs locally | tsci export |
| Ordering API | Connecting generated board files to manufacturing and ordering flows | Ordering API |
Core Libraries
| Tool | Use it for | Where to start |
|---|---|---|
| tscircuit/core | The React-to-Circuit-JSON engine used by the editor, CLI, and previews | Programmatically building circuits |
| Circuit JSON | The intermediate format shared by viewers, exporters, and APIs | Display Circuit JSON on a webpage |
| Footprinter | Creating reusable PCB footprints from compact footprint strings | Footprinter strings |