Skip to main content
Command Line Interface

tsci init

tsci init bootstraps a fresh project in the current directory. It creates the basic files needed to start developing a board, including:

  • index.tsx – your main circuit entrypoint
  • package.json with the required dependencies
  • tsconfig.json
  • .gitignore and other configuration files

You can run the command interactively or pass -y to accept all defaults.

Options​

  • -y, --yes – use defaults and skip prompts
  • --no-install – skip installing dependencies after initialization
mkdir my-circuit
cd my-circuit
# Initialize with prompts
tsci init
# or skip prompts
tsci init -y
# skip dependency installation
tsci init -y --no-install

After initialization you will see a directory structure similar to the following:

my-circuit/
├─ index.tsx
├─ package.json
├─ tsconfig.json
└─ tscircuit.config.json
tsci init
Created: ./index.tsx
Created: ./.npmrc
Created: ./package.json
Created: ./tsconfig.json
Created: ./.gitignore
Initializing project in ./...
Updated package.json to remove unnecessary fields.
Installing dependencies...

added 38 packages, and audited 39 packages in 26s

3 packages are looking for funding
  run `npm fund` for details

found 0 vulnerabilities
Dependencies installed successfully.
🎉 Initialization complete! Run "tsci dev" to start developing.

Next, run tsci dev to start the development server and view your circuit in the browser.