README.md

tsci - The TSCircuit Command Line & Development Tools

Caution

The v0.0.x version of the CLI has been completely rewritten, check out the new version here

---

Command line tool for developing tscircuit projects and interacting with the tscircuit registry.

Installation

npm install -g @tscircuit/cli

Usage

The tsci CLI is interactive by default. You can specify the -y or any fully- qualified with all required arguments to skip the interactive mode.

# Interactively choose a command and options:
tsci

# Login
tsci login

# Create a Project
tsci init

# Develop a Project (preview, export, and edit circuit files in browser)
tsci dev

# Manage Dependencies
tsci install
tsci add some-package
tsci remove some-package

# Publish a Project
tsci publish

Developing

This project is developed with bun, make sure you have that installed.

Run bun install to install dependencies and bun cli/cli.ts to run test the cli in development, or bun run dev to run the dev server.

To run tests, run bun test

If you want to test developing, run bun dev and visit http://127.0.0.1:5173. The project being loaded is inside example-project

Features Coming Soon

• tsci format
• tsci lint
• tsci open