Skip to content

update tsci add docs #757

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rushabhcodes wants to merge 2 commits into
base: main
Choose a base branch
from
+14 −5
Open

update tsci add docs #757

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
66f8179
update tsci add docs
rushabhcodes Jun 22, 2026
dcb0e31
update
rushabhcodes Jun 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions docs/command-line/tsci-add.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,24 @@
---
title: tsci add
description: Install tscircuit registry packages using the tsci add command
description: Install one or more tscircuit packages using the tsci add command

@imrishabh18 imrishabh18 Jun 22, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why?

---

`tsci add` is the same as `npm add` or `bun add`, but defaults to the tscircuit
registry. If your project has the [tsci `.npmrc`](../web-apis/the-registry-api.md#using-the-tscircuit-npm-registry), you can just do `bun add @tsci/<author>.<package>`
and it has the same effect.

## Usage

```bash
tsci add <packageSpecs...>
Comment on lines +10 to +13

@imrishabh18 imrishabh18 Jun 22, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Usage
```bash
tsci add <packageSpecs...>

```
> tsci add seveibar/PICO_W
# Added @tsci/seveibar.PICO_W@0.0.1

## Examples

```bash
$ tsci add @tsci/seveibar.PICO @tsci/seveibar.Key
# Adding @tsci/seveibar.PICO @tsci/seveibar.Key...
# ✓ Added @tsci/seveibar.PICO @tsci/seveibar.Key successfully
Comment on lines -11 to +21

@imrishabh18 imrishabh18 Jun 22, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know why would you change this, it's standard to show a single package install with the add command.

```

You can then import the module and use it for your board!
Expand Down
4 changes: 2 additions & 2 deletions docs/intro/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ CLI for developing tscircuit packages
# export [options] <file> Export tscircuit code to various formats
# build [options] [file] Run tscircuit eval and output circuit json
# transpile [file] Transpile TypeScript/TSX to JavaScript
# add <packageSpec> Add a tscircuit component package
# add <packageSpecs...> Add tscircuit component packages to your project
# remove <component> Remove a tscircuit component package
# snapshot [options] [path] Generate schematic/PCB snapshots
# setup Setup utilities like GitHub Actions
Expand Down Expand Up @@ -83,7 +83,7 @@ tsci
# tsci config - Manage tscircuit CLI configuration
# tsci export - Export tscircuit code to various formats
# tsci build - Run tscircuit eval and output circuit json
# tsci add - Add a tscircuit component package
# tsci add - Add tscircuit component packages to your project
# tsci snapshot - Generate schematic and PCB snapshots
# tsci doctor - Run diagnostic checks
# tsci search - Search for footprints, CAD models or packages
Expand Down
Loading