diff --git a/docs/command-line/tsci-export.md b/docs/command-line/tsci-export.md index 27907878..580a39cc 100644 --- a/docs/command-line/tsci-export.md +++ b/docs/command-line/tsci-export.md @@ -2,8 +2,72 @@ title: tsci export --- +import ImageWithCaption from "../../src/components/ImageWithCaption" + ## Overview `tsci export` can be used to convert a `tsx` file or `circuit.json` file into -schematic PDFs, fabrication files, gerbers, pick'n'place files, netlists and -many more formats. +various output formats including schematics, PCB layouts, fabrication files, and more. + + + +## Usage + +```bash +tsci export [options] +``` + +### Arguments +- ``: Path to the source file (`.tsx` or `.circuit.json`) + +### Options +- `-f, --format `: Output format (defaults to "json") +- `-o, --output `: Custom output file path + +## Supported Formats + +The following export formats are supported: + +| Format | Description | +|--------|-------------| +| `circuit-json`| Circuit JSON format | +| `schematic-svg` | Schematic view as SVG | +| `pcb-svg` | PCB layout as SVG | +| `readable-netlist` | Human-readable netlist | +| `specctra-dsn` | Specctra DSN format for autorouting | + +## Examples + +Export to circuit JSON: +```bash +tsci export circuit.tsx +``` + +Export as schematic SVG: +```bash +tsci export circuit.tsx -f schematic-svg +``` + +Export PCB layout with custom output path: +```bash +tsci export circuit.tsx -f pcb-svg -o my-pcb-layout.svg +``` + +Export to Specctra DSN format: +```bash +tsci export circuit.tsx -f specctra-dsn +``` + +## Output Files + +By default, the exported file will be saved in the same directory as the input file, with a filename based on the input filename and the chosen format. For example: + +- Input: `my-circuit.tsx` +- Format: `pcb-svg` +- Default output: `my-circuit-pcb.svg` + +You can override the output location using the `-o` or `--output` option.