diff --git a/docs/command-line/tsci-add.mdx b/docs/command-line/tsci-add.mdx index 3914e862..f6d9d3e2 100644 --- a/docs/command-line/tsci-add.mdx +++ b/docs/command-line/tsci-add.mdx @@ -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 --- `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/.` and it has the same effect. +## Usage + +```bash +tsci add ``` -> 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 ``` You can then import the module and use it for your board! diff --git a/docs/intro/installation.md b/docs/intro/installation.md index 1bfb431e..2bc7f60e 100644 --- a/docs/intro/installation.md +++ b/docs/intro/installation.md @@ -50,7 +50,7 @@ CLI for developing tscircuit packages # export [options] Export tscircuit code to various formats # build [options] [file] Run tscircuit eval and output circuit json # transpile [file] Transpile TypeScript/TSX to JavaScript -# add Add a tscircuit component package +# add Add tscircuit component packages to your project # remove Remove a tscircuit component package # snapshot [options] [path] Generate schematic/PCB snapshots # setup Setup utilities like GitHub Actions @@ -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