feat: add and enhance documentation for various tsci command-line tools.#487
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
This PR expands and standardizes the documentation for the tsci CLI by adding new command pages and enriching existing ones with clearer usage, flags, subcommands, and examples—improving discoverability and consistency across the CLI docs section.
Changes:
- Added new documentation pages for previously undocumented
tscicommands (e.g.version,upgrade,transpile,simulate,doctor,config,clone, etc.). - Enhanced existing command docs with new options/flags, supported formats, and more complete auth/config guidance.
- Updated and aligned command page content (usage blocks, arguments/options sections, examples) across multiple CLI docs.
Reviewed changes
Copilot reviewed 20 out of 20 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/command-line/tsci-version.md | New page documenting tsci version and version flags. |
| docs/command-line/tsci-upgrade.md | New page documenting tsci upgrade. |
| docs/command-line/tsci-transpile.md | New page documenting library transpilation outputs (dist/ artifacts). |
| docs/command-line/tsci-simulate.md | New page documenting simulation subcommands (analog SPICE). |
| docs/command-line/tsci-setup.md | New page documenting interactive setup utilities (GitHub Actions workflow). |
| docs/command-line/tsci-search.md | Adds source-filter options (--kicad, --jlcpcb, etc.) to search docs. |
| docs/command-line/tsci-remove.md | New page documenting package removal (tsci remove). |
| docs/command-line/tsci-push.md | Adds structured usage/arguments/options for publishing packages. |
| docs/command-line/tsci-login.md | Expands auth documentation with additional tsci auth subcommands. |
| docs/command-line/tsci-install.md | New page documenting dependency/package installation flows. |
| docs/command-line/tsci-init.md | Adds options documentation (--yes, --no-install) to init docs. |
| docs/command-line/tsci-import.md | New page documenting interactive component import across sources. |
| docs/command-line/tsci-export.md | Adds --disable-parts-engine and extends supported export formats list. |
| docs/command-line/tsci-doctor.md | New page documenting diagnostics command. |
| docs/command-line/tsci-dev.md | Adds structured usage/options and corrects localhost URL scheme. |
| docs/command-line/tsci-convert.md | New page documenting KiCad footprint conversion to TSX components. |
| docs/command-line/tsci-config.md | New page documenting config subcommands and supported keys. |
| docs/command-line/tsci-clone.md | New page documenting registry cloning options and config integration. |
| docs/command-line/tsci-check.md | New page documenting partial validation subcommands. |
| docs/command-line/tsci-build.md | Documents additional build flags for KiCad library naming and profiling. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ### Options | ||
| - `--kicad` – search KiCad footprints | ||
| - `--jlcpcb` – search JLCPCB components | ||
| - `--lcsc` – alias for `--jlcpcb` | ||
| - `--tscircuit` – search tscircuit registry packages | ||
|
|
||
| When no filter options are provided, all sources are searched. |
There was a problem hiding this comment.
The new Options section is introduced as a level-3 heading ("### Options") before the "## Usage" section, which is inconsistent with the structure used by most other docs/command-line/* pages (typically ## Usage then ### Arguments / ### Options). Consider moving these option bullets under ## Usage (or promoting this to a ## Options section) to keep the page outline consistent and easier to scan.
| ### Options | ||
| - `-y, --yes` – use defaults and skip prompts | ||
| - `--no-install` – skip installing dependencies after initialization | ||
|
|
There was a problem hiding this comment.
This page now introduces an "### Options" subsection, but there is still no explicit ## Usage section like the other CLI command pages (e.g. tsci build, tsci dev, tsci export). To match the standardized CLI docs format described in the PR, consider adding a ## Usage block (e.g. tsci init [options]) and nesting the options list under it so readers can quickly find invocation syntax and flags.
docs/command-line/tsci-version.md
Outdated
| You can also use the `-v` or `-V` or `--version` flags: | ||
|
|
||
| ```bash | ||
| tsci -v | ||
| tsci --version | ||
| ``` |
There was a problem hiding this comment.
This section mentions -V as an alternative version flag, but the example block only shows tsci -v and tsci --version. Consider either adding tsci -V to the example or removing the -V mention to avoid implying support that isn’t demonstrated here; also, listing the flags as “-v, -V, or --version” reads more cleanly.
seveibar
left a comment
seveibar
left a comment
There was a problem hiding this comment.
Give examples of command outputs, do not have empty sections
docs/command-line/tsci-push.md
Outdated
| ## Usage | ||
|
|
||
| ```bash | ||
| tsci push [file] [options] |
There was a problem hiding this comment.
what is wrong here?
There was a problem hiding this comment.
…tsci import`, `tsci install`, and `tsci simulate`
|
This PR has been automatically marked as stale because it has had no recent activity. It will be closed if no further activity occurs. |
|
This PR was closed because it has been inactive for 1 day since being marked as stale. |
|
Thank you for your contribution! 🎉 PR Rating: ⭐⭐⭐ Track your contributions and see the leaderboard at: tscircuit Contribution Tracker |
This pull request significantly expands and standardizes the tscircuit CLI documentation. It adds full documentation for many previously undocumented commands, improves and clarifies options for existing commands, and enhances authentication and configuration docs. The update also documents new export and simulation formats and unifies formatting (usage, options, examples) across all CLI command pages for better clarity and consistency.
https://docs-pegcd6638-tscircuit.vercel.app/category/command-line-interface