The shapemason CLI
shapemason converts files from a terminal, in scripts and in batches.
Install it, then:
shapemason FILE… # convert by kind: vector art to DXF, meshes to STEPshapemason COMMAND [FLAGS] FILE… # or choose what to make| Command | Does |
|---|---|
sketch |
SVG / DXF → DXF sketch (guide) |
extrude |
SVG / DXF → STEP solid (guide) |
text TEXT… |
Text → DXF sketch, or with --depth a STEP solid (guide) |
mesh-to-solid |
Mesh → STEP solid (guide) |
split |
Mesh → one STEP per part |
section --at MM |
Mesh → DXF cross sections (guide) |
project |
Mesh → DXF silhouette |
preview |
An SVG or PNG picture of the result |
analyze |
What’s in a file and whether it converts cleanly; writes nothing |
validate |
Convert without writing; silent unless something needs attention |
Every command and flag: Command reference. Every option with its default: Options.
Batches and scripts
Section titled “Batches and scripts”shapemason -r -d out/ art/ # every supported file in art/, into out/shapemason validate parts/*.stl # exit 0 clean, 2 warnings, 1 failureshapemason analyze --json bracket.stl # machine-readable reportshapemason extrude logo.svg --stdout > logo.stepExisting outputs are never replaced without --overwrite
(output rules). --dry-run converts and reports
without writing.
The app and the web app show the equivalent command for every conversion (Copy in the report), so you can tune options there and paste the command into a script.
Shell completions
Section titled “Shell completions”shapemason completions zsh > ~/.zfunc/_shapemason # zsh (with ~/.zfunc on fpath)shapemason completions bash > ~/.local/share/bash-completion/completions/shapemasonshapemason completions fish > ~/.config/fish/completions/shapemason.fishPowerShell and Elvish are supported too.
Finder Quick Action (macOS)
Section titled “Finder Quick Action (macOS)”shapemason install-quick-action # "Convert with shapemason"shapemason install-quick-action --name "Extrude 3 mm" --args "extrude --depth 3"In Finder, select files and choose Quick Actions › Convert with
shapemason. Problems are posted as notifications.
shapemason uninstall-quick-action --name … removes one. With the app
installed, you can use Shortcuts instead.
Telemetry
Section titled “Telemetry”Release builds send anonymous usage events: command names, file formats,
error kinds. Never files, names or paths. Turn it off with
shapemason telemetry off, or set SHAPEMASON_TELEMETRY=0 or
DO_NOT_TRACK=1. It is always off when CI is set.
shapemason telemetry status says whether it is on and why. See the
privacy policy.
Third-party licences
Section titled “Third-party licences”shapemason licenses prints the licences of the software built into the
binary.