Export commands#
Exports are commands under jitx design export. The available commands depend
on the jitx-plugin entry points installed in the same Python environment as
jitx. Experimental feature settings can also enable commands. Check that
environment with jitx design export --help.
The commands below require an importable fully qualified Design class, an
installed and authenticated runtime, and a reachable runtime connection. They
submit and capture the design before invoking the exporter. Unlike design build,
the export command does not expose --project, --dry, or connection flags.
Run it from the project environment after starting that project’s runtime.
JITX supplies four legacy-* commands by default and an opt-in experimental
XML exporter. Their filenames and destination
handling are provided by the runtime’s legacy export flow; these CLI commands
accept only the design name, with no --output option. Keep the legacy- prefix
when invoking them. This reference covers all five, including the XML prerequisite below.
jitx design export#
Choose an installed exporter. See each command below for its accepted arguments.
jitx design export legacy-kicad#
Export design to KiCad using the legacy export flow.
jitx design export legacy-kicad myboard.main.Myboard
Argument / option |
Default |
Meaning |
|---|---|---|
|
required |
Fully qualified Design class name. |
jitx design export legacy-edx#
Export design to EDX using the legacy export flow.
jitx design export legacy-edx myboard.main.Myboard
Argument / option |
Default |
Meaning |
|---|---|---|
|
required |
Fully qualified Design class name. |
jitx design export legacy-odb++#
Export board to ODB++ using the legacy export flow.
jitx design export legacy-odb++ myboard.main.Myboard
Argument / option |
Default |
Meaning |
|---|---|---|
|
required |
Fully qualified Design class name. |
jitx design export legacy-step#
Export board to STEP using the legacy export flow.
jitx design export legacy-step myboard.main.Myboard
Argument / option |
Default |
Meaning |
|---|---|---|
|
required |
Fully qualified Design class name. |
jitx design export legacy-xml#
Export design to XML using the legacy export flow. This command is experimental
and is registered only when JITX_EXPERIMENTAL_FEATURES contains xml-export.
Without that setting it does not appear in jitx design export --help.
JITX_EXPERIMENTAL_FEATURES=xml-export jitx design export legacy-xml myboard.main.Myboard
In PowerShell, set $env:JITX_EXPERIMENTAL_FEATURES = "xml-export" before
running the command. If you already enable other experimental features, include
xml-export in the comma-separated value alongside them.
Argument / option |
Default |
Meaning |
|---|---|---|
|
required |
Fully qualified Design class name. |