Skip to content

Add docs for the --json flag in tsci search command #526

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

Merged
MustafaMulla29 merged 1 commit into from
Apr 6, 2026
Merged

Add docs for the --json flag in tsci search command #526

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
39 changes: 39 additions & 0 deletions docs/command-line/tsci-search.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ description: Discover footprints and packages across the tscircuit ecosystem
- `--jlcpcb` – search JLCPCB components
- `--lcsc` – alias for `--jlcpcb`
- `--tscircuit` – search tscircuit registry packages
- `--json` – output search results as JSON

When no filter options are provided, all sources are searched.

Expand All @@ -35,3 +36,41 @@ Found 11 package(s) in the tscircuit registry:
```

Use any search term to discover related footprints or published projects.

### JSON Output Example

You can output search results as JSON by using the `--json` flag.

```bash
$ tsci search --jlcpcb "RP2040" --json
```

```json
{
"query": "RP2040",
"results": [
{
"source": "jlcpcb",
"lcsc": 2040,
"mfr": "RP2040",
"package": "LQFN-56(7x7)",
"is_basic": false,
"is_preferred": false,
"description": "",
"stock": 42449,
"price": 0.872857143
},
{
"source": "jlcpcb",
"lcsc": 5350143,
"mfr": "RP2040-Zero",
"package": "-",
"is_basic": false,
"is_preferred": false,
"description": "",
"stock": 51,
"price": 5.091428571
}
]
}
```
Loading