Command Line Interface | tscircuit docs

tsci init

Initialize a new TSCircuit project

Run a local preview server for your tscircuit project

tsci push uploads your package to the tscircuit registry for module re-use

Install tscircuit registry packages using the tsci add command

Print your current tscircuit API token for use with web services

Generate circuit JSON from your source files

Partially build and validate circuit artifacts

Clone a package from the tscircuit registry to your local machine

Manage tscircuit CLI configuration

Convert a KiCad footprint file to a tscircuit component

Run diagnostic checks for your tscircuit setup

Export tscircuit files to various formats including SVG schematics, PCB layouts, and fabrication files.

Search JLCPCB or the tscircuit registry and import a component into your project

Install project dependencies or a specific package

Remove a tscircuit component package from your project

Discover footprints and packages across the tscircuit ecosystem

Setup utilities for your tscircuit project

Run circuit simulations from the command line

Generate schematic and PCB snapshots for regression tests

Transpile TypeScript/TSX to JavaScript for distribution as a reusable library

Upgrade the tscircuit CLI to the latest version

Print the tscircuit CLI version