Skip to main content
Contributing

User-Facing Tools

This page maps the tscircuit tools that users see directly to the repositories that maintain them. Use it when you are deciding where to report a bug, open a pull request, or look for related implementation details.

Design and Sharing

ToolWhat users use it forMain repository
tscircuit editorWrite, preview, and share circuit boards in the browser.tscircuit/tscircuit.com
tsci CLICreate local projects, run tsci dev, and work with packages from a terminal.tscircuit/cli
tscircuit docsLearn the React component API, tutorials, guides, web APIs, and contribution workflow.tscircuit/docs
Package registryFind, install, and publish reusable tscircuit packages.tscircuit/tscircuit.com

Circuit Previews

ToolWhat users use it forMain repository
RunFrameEmbed a live tscircuit preview in docs, examples, apps, and generated sites.tscircuit/runframe
PCB viewerRender interactive 2D PCB views from Circuit JSON.tscircuit/pcb-viewer
3D viewerRender 3D board previews and component models.tscircuit/3d-viewer
Schematic viewerRender schematic views from Circuit JSON.tscircuit/schematic-viewer
Circuit JSON viewerInspect Circuit JSON and convert it into visual formats.tscircuit/circuitjson.com

Parts and Footprints

ToolWhat users use it forMain repository
FootprinterGenerate PCB footprints from short footprint strings.tscircuit/footprinter
JLC searchSearch JLCPCB parts and inspect part metadata before importing parts.tscircuit/jlcsearch
EasyEDA converterConvert EasyEDA and JLCPCB package data into tscircuit-compatible assets.tscircuit/easyeda-converter
KiCad component converterConvert KiCad symbols and footprints into tscircuit component data.tscircuit/kicad-component-converter

Routing and Fabrication

ToolWhat users use it forMain repository
Autorouting.comTry routing jobs and inspect autorouter behavior outside the editor.tscircuit/autorouting
AutorouterRoute traces between PCB pads from Circuit JSON and Simple Route JSON.tscircuit/tscircuit-autorouter
Circuit JSON to GerberExport fabrication files for PCB manufacturers.tscircuit/circuit-json-to-gerber
Circuit JSON to KiCadExport tscircuit projects into KiCad-compatible formats.tscircuit/circuit-json-to-kicad

Libraries Behind the Tools

LibraryWhat it ownsMain repository
CoreThe React component runtime that turns components into Circuit JSON.tscircuit/core
PropsThe shared prop definitions for built-in tscircuit elements.tscircuit/props
Circuit JSONThe data format used between renderers, routers, exporters, and viewers.tscircuit/circuit-json
Schematic symbolsSymbol data used by schematic renderers and docs examples.tscircuit/schematic-symbols