Skip to main content

Quickstart CLI

Overview​

The command line is the best way to use tscircuit. Using the CLI, you can just run tsci dev in a project and see previews of your circuit just like any other local development tool!

Install the tscircuit CLI​

You can install the tscircuit CLI by running npm install -g @tscircuit/cli.

Create a new Project​

First, create a new tscircuit project by running tsci init. This will create a new directory with all the necessary files to get started:

tsci init result

Run the Development Server​

Next, start the development server by running tsci dev. This will start a local server that automatically rebuilds your circuit when you make changes:

tsci dev result

Go to https://localhost:3020. You can now see PCB, Schematic and 3D views of your circuit, which update in real-time as you make changes to your code.

browser

Pushing to the tscircuit Registry​

Next, you push your project by running tsci push. This will push your project to your registry. tsci push result

Go to your tscircuit account. You can now see PCB, Schematic and 3D views of your circuit in you registry. browser

Exporting to SVGs, PDF, or Fabrication Files​

This section is coming soon!