Skip to content

update tsci add docs#757

Open
rushabhcodes wants to merge 2 commits into
mainfrom
update-tsci-add-multi-package-docs
Open

update tsci add docs#757
rushabhcodes wants to merge 2 commits into
mainfrom
update-tsci-add-multi-package-docs

Conversation

@rushabhcodes

Copy link
Copy Markdown
Contributor

Summary

Updates the docs to match the recent CLI change that allows tsci add to accept multiple package specifiers in one command.

What changed

  • updated the tsci add command reference to show tsci add <packageSpecs...>
  • added an example showing multiple packages installed in a single command
  • updated the installation page help output to match current CLI wording
  • aligned the tsci add description with the current command behavior

Why

The CLI now supports adding multiple packages in one invocation, but the docs still described tsci add as a single-package command in some places. This created avoidable confusion when following the
command reference and installation docs.

User impact

Users can now see the correct tsci add syntax and a working multi-package example directly in the docs, which makes the CLI behavior easier to discover and use correctly.

@vercel

vercel Bot commented Jun 22, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Jun 22, 2026 10:40am

Request Review

@imrishabh18 imrishabh18 left a comment

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.

Reference docs of bun or npm

Comment on lines -11 to +21
> 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

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.

Comment on lines +10 to +13
## Usage

```bash
tsci add <packageSpecs...>

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...>

---
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

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?

@github-actions

Copy link
Copy Markdown

This PR has been automatically marked as stale because it has had no recent activity. It will be closed if no further activity occurs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants