@tscircuit/cli 0.1.2455 → 0.1.2457
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +0 -143
- package/dist/cli/main.js +2 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -74,149 +74,6 @@ Commands:
|
|
|
74
74
|
```
|
|
75
75
|
<!-- END_HELP_OUTPUT -->
|
|
76
76
|
|
|
77
|
-
The `build` command also accepts the following options:
|
|
78
|
-
|
|
79
|
-
- `--ignore-errors` - continue build even if circuit JSON contains errors
|
|
80
|
-
- `--ignore-warnings` - suppress warning output
|
|
81
|
-
- `--ignore-netlist-drc` - suppress netlist DRC diagnostics
|
|
82
|
-
- `--ignore-pin-specification-drc` - suppress pin-specification DRC diagnostics
|
|
83
|
-
- `--ignore-placement-drc` - suppress placement DRC diagnostics
|
|
84
|
-
- `--ignore-routing-drc` - suppress routing DRC diagnostics
|
|
85
|
-
|
|
86
|
-
### Altium export
|
|
87
|
-
|
|
88
|
-
Export a TSX circuit or an existing Circuit JSON file as an Altium project:
|
|
89
|
-
|
|
90
|
-
```bash
|
|
91
|
-
tsci export board.tsx --format altium
|
|
92
|
-
tsci export board.circuit.json --format altium --output board-altium.zip
|
|
93
|
-
```
|
|
94
|
-
|
|
95
|
-
The ZIP contains native `.PcbDoc` and `.SchDoc` files and a `.PrjPcb` project,
|
|
96
|
-
generated by `circuit-json-to-altium`. Open the `.PrjPcb` file in Altium Designer.
|
|
97
|
-
Without `--output`, the archive is saved beside the input as `<input-basename>-altium.zip`.
|
|
98
|
-
|
|
99
|
-
### KiCad PCM compatibility
|
|
100
|
-
|
|
101
|
-
`tsci build --kicad-pcm` uses the package license from `package.json` and
|
|
102
|
-
selects the oldest compatible PCM schema by default. Licenses accepted by PCM
|
|
103
|
-
schema v1 produce a feed for KiCad 6–10. Other non-empty license strings use
|
|
104
|
-
schema v2 and require KiCad 10 or newer.
|
|
105
|
-
|
|
106
|
-
Projects can select a schema or declare a distribution-specific PCM license in
|
|
107
|
-
`tscircuit.config.json`:
|
|
108
|
-
|
|
109
|
-
```json
|
|
110
|
-
{
|
|
111
|
-
"kicadPcm": {
|
|
112
|
-
"schemaVersion": "auto",
|
|
113
|
-
"license": "CC-BY-ND-4.0"
|
|
114
|
-
}
|
|
115
|
-
}
|
|
116
|
-
```
|
|
117
|
-
|
|
118
|
-
Set `schemaVersion` to `1` or `2` to force a schema. Forcing v1 rejects licenses
|
|
119
|
-
that are not in KiCad's v1 license list instead of substituting another license.
|
|
120
|
-
|
|
121
|
-
### Debug autorouting stages
|
|
122
|
-
|
|
123
|
-
Use `--autorouter-debug` to log each autorouting stage and write visual
|
|
124
|
-
artifacts while the circuit is being routed:
|
|
125
|
-
|
|
126
|
-
```bash
|
|
127
|
-
tsci build index.circuit.tsx \
|
|
128
|
-
--autorouter-debug \
|
|
129
|
-
--autorouter-debug-dir dist/autorouter-debug \
|
|
130
|
-
--autorouter-dump-srj all
|
|
131
|
-
```
|
|
132
|
-
|
|
133
|
-
The debug directory contains:
|
|
134
|
-
|
|
135
|
-
- `placement-unrouted.png` — PCB placement before routing starts.
|
|
136
|
-
- `phase-N-routed.png` — cumulative PCB routing after each zero-indexed stage.
|
|
137
|
-
A fanout router and its downstream router appear as separate stages.
|
|
138
|
-
- `phase-N.input.simple-route.json` and `phase-N.output.traces.json` when
|
|
139
|
-
`--autorouter-dump-srj all` is enabled.
|
|
140
|
-
- `board.meta.json` — phase timing and connection-count summary, including the
|
|
141
|
-
resolved router, solver pipeline, effort, and cache status/key.
|
|
142
|
-
|
|
143
|
-
The live stage log prints the same routing metadata, using a compact cache ID
|
|
144
|
-
to keep terminal lines readable; artifacts retain the full cache key. This
|
|
145
|
-
makes it explicit when a result was computed, reused from the local cache, or
|
|
146
|
-
run without caching and records why caching was disabled.
|
|
147
|
-
|
|
148
|
-
Use `--autorouter-dump-srj failed` to keep only failed-stage routing data, or
|
|
149
|
-
`--autorouter-dump-srj phase:N` to capture a single stage.
|
|
150
|
-
|
|
151
|
-
To submit one of these inputs as an autorouter bug report, log in and pass the
|
|
152
|
-
selected input file to `tsci report autorouter`:
|
|
153
|
-
|
|
154
|
-
```bash
|
|
155
|
-
tsci login
|
|
156
|
-
tsci report autorouter \
|
|
157
|
-
dist/autorouter-debug/phase-0.input.simple-route.json \
|
|
158
|
-
--title "USB board routing failure"
|
|
159
|
-
```
|
|
160
|
-
|
|
161
|
-
The command uploads only the selected Simple Route JSON and prints a shareable
|
|
162
|
-
bug-report URL. Autorouter bug reports are public; the command asks for
|
|
163
|
-
confirmation before uploading. Pass `--yes` when running non-interactively.
|
|
164
|
-
|
|
165
|
-
Use `--autorouter-phase <name>` to enable the debugger automatically and keep
|
|
166
|
-
debugging through the named `<autoroutingphase name="..." />`. Later phases
|
|
167
|
-
are left out of the debug artifacts.
|
|
168
|
-
|
|
169
|
-
### Debug solver inputs
|
|
170
|
-
|
|
171
|
-
Use `--solver-debug` to record the constructor inputs for every solver that
|
|
172
|
-
the circuit reports while it renders:
|
|
173
|
-
|
|
174
|
-
```bash
|
|
175
|
-
tsci build index.circuit.tsx \
|
|
176
|
-
--solver-debug \
|
|
177
|
-
--solver-debug-dir dist/solver-debug
|
|
178
|
-
```
|
|
179
|
-
|
|
180
|
-
Each circuit writes a `solver-inputs.json` artifact beneath the debug
|
|
181
|
-
directory. The file preserves solver event order, identifies the component
|
|
182
|
-
that started each solver, and contains the full constructor argument tuple so
|
|
183
|
-
the solver can be reproduced independently. Values that JSON cannot represent
|
|
184
|
-
directly, such as `undefined`, `NaN`, maps, sets, or circular references, use
|
|
185
|
-
explicit `value_type` records instead of being silently discarded.
|
|
186
|
-
|
|
187
|
-
## Searching DigiKey and Mouser parts
|
|
188
|
-
|
|
189
|
-
Use `--digikey` or `--mouser` for distributor stock and supplier part numbers:
|
|
190
|
-
|
|
191
|
-
```sh
|
|
192
|
-
tsci search --digikey LM358
|
|
193
|
-
tsci search --mouser --json "buck converter"
|
|
194
|
-
tsci search --digikey --mouser LM358
|
|
195
|
-
tsci search --ti --digikey --mouser --json TPS62160
|
|
196
|
-
```
|
|
197
|
-
|
|
198
|
-
Results come from [DigiKey Search](https://digikeysearch.tscircuit.com) and
|
|
199
|
-
[Mouser Search](https://mousersearch.tscircuit.com), without requiring distributor
|
|
200
|
-
API credentials. Text output includes supplier part numbers; JSON preserves
|
|
201
|
-
returned part metadata with `source: "digikey"` or `source: "mouser"`.
|
|
202
|
-
Stock and pricing reflect the services' cached responses. These flags provide
|
|
203
|
-
part discovery, not direct TSX import from distributors.
|
|
204
|
-
|
|
205
|
-
## Searching Texas Instruments parts
|
|
206
|
-
|
|
207
|
-
Use `--ti` to search the TI catalog indexed by [tisearch](https://tisearch.tscircuit.com):
|
|
208
|
-
|
|
209
|
-
```sh
|
|
210
|
-
tsci search --ti TPS62160
|
|
211
|
-
tsci search --ti --json "buck converter"
|
|
212
|
-
tsci search --ti --jlcpcb TPS62160
|
|
213
|
-
```
|
|
214
|
-
|
|
215
|
-
JSON results identify TI parts with `source: "ti"` and include stored stock,
|
|
216
|
-
pricing, and product links. No TI API credentials are needed. Search reads the
|
|
217
|
-
indexed catalog; stock and metadata reflect the latest completed background
|
|
218
|
-
refresh. This flag provides part discovery, not TSX component import.
|
|
219
|
-
|
|
220
77
|
## Development
|
|
221
78
|
|
|
222
79
|
This command will open the `index.tsx` file for editing.
|
package/dist/cli/main.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
[diffend] Oversized file quarantined before diffing.
|
|
2
2
|
name: package/dist/cli/main.js
|
|
3
|
-
size:
|
|
4
|
-
sha256:
|
|
3
|
+
size: 48011312 bytes
|
|
4
|
+
sha256: 673c96041700b255721df6ade28d0f53c4cf1222c84451d74ceb342fd14f1a8a
|