Skip to content

About

Automated technical-drawing generation for STEP files

Topics

Resources

Contributing

Stars

48 stars

Watchers

2 watching

Forks

Repository files navigation

draftwright: technical drawings, generated

crates.io CI Licence: AGPL-3.0

Draftwright turns a STEP model into a dimensioned engineering drawing: SVG, PDF or editable DXF. It recognises manufacturing features, reads requirements from the STEP file, chooses views and dimensions, and lays them out on standard sheets. It reports what it could not state.

An A4 drawing of an electronics enclosure base: plan, front and side views, section A–A, an isometric view, the pocket and mounting-hole callouts and a title block
An electronics enclosure base made by a text-to-CAD tool, drawn by 0.6.0-alpha.2 from its STEP file with only the title set. Every view, dimension and callout is placed automatically.

Contents: Examples · Install · Command line · Output and the Spec · Python · What it does · Assemblies and revisions · With agents · Documentation · How it's built · Related projects · Licence and contributing

The current version is 0.6.1 (release notes). 0.6.0 made it about ten times faster than the Python 0.4 package in a sixth of the memory (0.6.0 notes).

Examples

To see what draftwright does with real parts, browse pzfreo/dw-examples: NIST test parts, FreeCAD library parts, text-to-CAD and build123d parts, and assemblies, each drawn by the stock CLI with only a title block set. They are unreviewed output, mistakes included, and each drawing's .review.json lists what draftwright found it could not state. Its CI rebuilds them whenever the pinned draftwright release is bumped.

Circular flange drawing NEMA 17 mount bracket drawing NIST FTC-06 drawing with hole tables and a section
Flange: bolt circle callout Bracket: slots, chamfers, fillets NIST FTC-06: hole tables, GD&T, section

Install

For the command line on macOS or Linux (arm64 / x86_64):

curl -fsSL https://raw.githubusercontent.com/pzfreo/draftwright/main/install.sh | sh

To inspect it first: download install.sh, read it, then run sh install.sh. For Windows, in PowerShell 5.1 or 7:

irm https://raw.githubusercontent.com/pzfreo/draftwright/main/install.ps1 | iex

The installers verify SHA-256 checksums and install draftwright and draftwright-mcp without administrator access. Set DRAFTWRIGHT_INSTALL_DIR to change the destination, or DRAFTWRIGHT_VERSION=v0.6.0 (also accepts 0.6.0) to pin a release instead of the latest stable. On macOS/Linux, set these variables on sh when piping, e.g. curl -fsSL https://raw.githubusercontent.com/pzfreo/draftwright/main/install.sh | DRAFTWRIGHT_VERSION=v0.6.0 sh. On Windows, set $env:DRAFTWRIGHT_VERSION / $env:DRAFTWRIGHT_INSTALL_DIR before the irm line.

Installer platform Binary Default destination
macOS arm64 (including a Rosetta shell) aarch64-apple-darwin ~/.local/bin
macOS Intel x86_64-apple-darwin ~/.local/bin
Linux x86_64 x86_64-unknown-linux-gnu, glibc >= 2.17 for releases newer than v0.6.0 ~/.local/bin
Linux arm64 aarch64-unknown-linux-gnu, glibc >= 2.17 ~/.local/bin
Windows x64 / ARM64 x86_64-pc-windows-msvc (x64 emulation on ARM64) %LOCALAPPDATA%\Programs\draftwright\bin, added to USER PATH

Releases through v0.6.0 require glibc >= 2.35 on Linux x86_64; v0.6.0 has no Linux arm64 or Intel Mac archive. The installers report unavailable targets explicitly. Linux archives require glibc; on Alpine/musl, use the Python package or build with Cargo. For other platforms or unavailable older targets, use uv tool install draftwright or cargo install draftwright, or see Releases.

You use Install Platforms
Python 3.9+ (abi3) pip install draftwright, or uv add draftwright in a uv project (PyPI, Python guide); no Rust needed Linux x86_64 and aarch64, macOS arm64 and x86_64, Windows x64
Command line uv tool install draftwright; installs draftwright and draftwright-mcp The same five wheel platforms
Rust crate cargo install draftwright for both binaries; draftwright = "0.6" for the library (operations) Native Rust toolchain
Prebuilt archives Download a CLI archive from Releases; includes both binaries, schemas and agent docs macOS arm64 / Intel, Linux x86_64 / arm64, Windows x64; availability depends on the release
Browser draftwright.io WebAssembly (package guide)

0.6 replaces the old Python package of the same name; pin draftwright<0.6 to keep it.

Upgrading from the old Python package. If you installed 0.4 or 0.5 as a tool with uv or pipx, its draftwright command stays on your PATH and the new install won't replace it. Remove the old one first, then install 0.6:

uv tool uninstall draftwright        # if you used uv
pipx uninstall draftwright           # if you used pipx
uv tool install draftwright          # or: pipx install draftwright
draftwright --version                # should print 0.6.0 or later

If pipx says the command "is not on your PATH" or points elsewhere, pipx install --force takes the link over. An older Rust build in ~/.cargo/bin can also shadow it: cargo uninstall draftwright.

If you installed shell completion for the old command (--install-completion), pressing Tab after draftwright prints a mess until you replace it. Write the new script over the old one, then open a new shell:

draftwright completions zsh  > ~/.zfunc/_draftwright                       # zsh
draftwright completions bash > ~/.bash_completions/draftwright.sh          # bash
draftwright completions fish > ~/.config/fish/completions/draftwright.fish # fish

For PowerShell, run this in the current session or add it to $PROFILE:

draftwright completions powershell | Out-String | Invoke-Expression

Command line

draftwright render part.step -o part --formats svg,pdf,dxf  # includes editable DXF
draftwright render part.step -o part --units in --paper ansi
draftwright render part.step -o part --max-size A3
draftwright render part.step -o part --set views/iso/omit=true
draftwright review part.step

review prints JSON containing the drawing as SVG text, the problems and lint's findings. The command-line reference lists commands, common options and tested --set settings, including paper and pictorial choices. draftwright completions zsh prints a completion script; see shell completion for installation and the other supported shells.

Output and the Spec

A Spec is a small JSON file of drawing settings and edits. Without one, draftwright uses its automatic choices. render writes part.svg, part.pdf and part.dxf for the first command above (SVG and PDF by default); PNG is also available. Extra sheets get numbered files, while PDF holds all the sheets. Each format embeds the Spec that made it, and the command prints JSON listing the files and problems.

For example, save this as part.drawing.json to fill in the title block:

{ "sheet": { "title": { "title": "Mounting plate", "number": "MP-001" } } }
draftwright render part.step --spec part.drawing.json -o part
draftwright spec part.pdf  # read the embedded Spec

The model and Spec reference describes the settings, documents and Rust API.

Python

from draftwright import make_drawing, Part
svg, dxf = make_drawing("part.step", out="drawing", title="Bracket")
from build123d import Box
part = Part(Box(120, 80, 20), "plate", title="Mounting plate")
svg, dxf = part.drawing(sheet="A3").render("plate")

Install build123d separately for shapes and Part. Start with Drawings from build123d, then the Python guide for requirements, layout edits and the parts of the build123d API still being completed.

Moving from 0.4: see Python migration and CLI migration.

What it does

  • Recognises features with quiddity: holes, counterbores, patterns, slots, pockets, turned steps, grooves, chamfers, fillets and threads.
  • Dimensions features with rules for each family; omissions and placement failures are reported with a reason.
  • Reads AP242 PMI (tolerances and GD&T stored in the STEP file), including fits, datums, threads and surface finish. Unsupported requirements are reported.
  • Lays out sheets with views, sections, details, hole tables and an ISO 7200 title block; it chooses scale and paper size, using more sheets when needed.
  • Produces deterministic output: the same inputs give the same bytes. SVG and PDF carry real, searchable text; DXF has editable text, dimensions, blocks and title-block attributes.

Assemblies and revisions

draftwright pack assembly.step -o pack
draftwright diff old.step new.step --spec part.drawing.json -o changes

pack draws each made part once and writes an ISO 7573 parts list, item numbers and a CSV/JSON bill of materials. diff carries the Spec to a new revision, marks up what changed and reports edits that need a decision. See bills of materials and the engine guide.

With agents

The CLI release archives include draftwright-mcp, a local stdio MCP server for Claude and other MCP clients; the wheel and Cargo installs provide it too. Clients can inspect a part, edit its Spec, render the drawing and read the findings. The MCP guide also covers the newer local draftwright mcp-stdio and draftwright mcp-http adapters.

The Spec is the steering surface: an agent inspects the drawing and findings, changes settings or edits by item ID, then renders and reviews again. Requirements belong in STEP; the Spec controls the drawing.

Two agent skills ship in skills/: draftwright-step for any STEP file, as a basic drawing or with requirements written by Specify, and draftwright-build123d for build123d scripts. For Claude Code, copy a folder to .claude/skills/ in your project or to ~/.claude/skills/.

Documentation

How it's built

Draftwright is AI-coded with Claude and Codex, directed by its maintainer. Large changes get independent review. The output is deterministic, and the public examples are built by the stock CLI with no hand edits.

Related projects

  • quiddity: feature recognition from STEP B-rep, built on the haecceity geometry kernel that draftwright uses.
  • Specify: writes tolerances, fits, GD&T and BOM data into STEP as AP242 PMI; available at draftwright.io/specify.
  • dw-examples: the public example drawings.
  • draftwright-python: the earlier Python implementation, being retired.

Licence and contributing

Draftwright is licensed under the GNU AGPL v3.0, and is also available under separate commercial terms; contact paul@draftwright.io. quiddity and haecceity are Apache-2.0. The bundled IBM Plex fonts are under the SIL Open Font License 1.1.

Contributions are welcome. See CONTRIBUTING.md; pull requests need the Contributor License Agreement.

About

Automated technical-drawing generation for STEP files

Topics

Resources

Contributing

Stars

48 stars

Watchers

2 watching

Forks

Releases

Packages

Contributors

Languages