Skip to main content
Intro

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

ToolUse it forWhere to start
tscircuit.com editorWriting and previewing tscircuit projects in the browserQuickstart: web editor
tsci CLICreating, developing, building, and exporting projects locallyQuickstart: CLI
RunFrameEmbedding a live tscircuit runner inside another web pageRun tscircuit in an iframe

Preview and Inspection

ToolUse it forWhere to start
PCB viewerRendering and inspecting PCB layouts from Circuit JSONDisplay Circuit JSON on a webpage
3D viewerShowing board assemblies with 3D component modelsCad model element
Circuit preview componentShowing schematic, PCB, pinout, and 3D previews in docs or appsProgrammatically building circuits

Conversion and Importing

ToolUse it forWhere to start
JLCPCB importTurning JLCPCB parts into tscircuit componentsImporting from JLCPCB
KiCad importReusing KiCad libraries and symbols in tscircuit projectsImporting from KiCad
Circuit JSON importConverting existing Circuit JSON into reusable tscircuit codeImporting from Circuit JSON

Routing, Exporting, and Ordering

ToolUse it forWhere to start
Autorouting APIRouting PCB traces from Circuit JSON in automated workflowsAutorouting API
Export commandsExporting fabrication files, images, and project outputs locallytsci export
Ordering APIConnecting generated board files to manufacturing and ordering flowsOrdering API

Core Libraries

ToolUse it forWhere to start
tscircuit/coreThe React-to-Circuit-JSON engine used by the editor, CLI, and previewsProgrammatically building circuits
Circuit JSONThe intermediate format shared by viewers, exporters, and APIsDisplay Circuit JSON on a webpage
FootprinterCreating reusable PCB footprints from compact footprint stringsFootprinter strings