Skip to content

Updated the CLI documentation for tsci in the docs/intro/installation.md#516

Merged
rushabhcodes merged 1 commit intotscircuit:mainfrom
rushabhcodes:codex/improve-documentation-for-cli-commands
Mar 19, 2026
Merged

Updated the CLI documentation for tsci in the docs/intro/installation.md#516
rushabhcodes merged 1 commit intotscircuit:mainfrom
rushabhcodes:codex/improve-documentation-for-cli-commands

Conversation

@rushabhcodes
Copy link
Contributor

@rushabhcodes rushabhcodes commented Mar 19, 2026

This pull request updates the CLI documentation for tsci in the docs/intro/installation.md file, reflecting a shift in terminology from "snippets" to "packages" and adding several new commands. The changes improve clarity and provide a more comprehensive overview of the CLI's capabilities.

https://docs-ppdq2snn9-tscircuit.vercel.app/intro/installation

CLI documentation updates:

  • Changed terminology throughout the help output and command list from "snippets" to "packages" to better reflect the current focus of the CLI. [1] [2]
  • Added new commands to the CLI documentation, including push, logout, build, transpile, add, remove, snapshot, setup, install, upgrade, doctor, check, registry, search, import, convert, simulate, and version, providing a more complete reference for users. [1] [2]
  • Updated descriptions for existing commands and options to match the new terminology and expanded functionality. [1] [2]

Copilot AI review requested due to automatic review settings March 19, 2026 00:47
@vercel
Copy link

vercel bot commented Mar 19, 2026

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

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Mar 19, 2026 0:48am

Request Review

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the tsci installation/usage documentation to reflect the CLI’s newer “packages” terminology and a more complete command list, so new users get an up-to-date overview right after installation.

Changes:

  • Replaced “snippets” terminology with “packages” in the sample tsci --help and interactive menu output.
  • Expanded the documented tsci command list and refreshed command descriptions to match current CLI capabilities.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@rushabhcodes rushabhcodes merged commit 383b5d0 into tscircuit:main Mar 19, 2026
9 checks passed
@tscircuitbot
Copy link


Thank you for your contribution! 🎉

PR Rating: ⭐⭐⭐
Impact: Major

Track your contributions and see the leaderboard at: tscircuit Contribution Tracker


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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants