# Pegmatite

> Pegmatite Script (.pegm) builds 3D models from solids placed against one another. Use the editor or npm CLI to check models, inspect previews and export 3MF or STEP.

Read https://pegmatite.dev/guide/start.md first. Fetch other topics only when the task needs them.
The complete download is optional; do not load it by default.

## Guide

- [Pegmatite Script Guide](https://pegmatite.dev/guide/start.md): Read first: the whole language for common printed parts, recipes and the topic index.
- [Syntax, settings and scope](https://pegmatite.dev/guide/syntax.md): Name and string rules, statement forms, persistent settings, unset, scope and color.
- [Placement, faces and frames](https://pegmatite.dev/guide/placement.md): Anchors, alignment points and offsets, faces and frames, build planes, labels, lists and compounds.
- [Booleans, slots and parts](https://pegmatite.dev/guide/booleans.md): Subtraction, intersection, symmetric difference, boolean scope, slots and parts.
- [Expressions, functions and measures](https://pegmatite.dev/guide/expressions.md): Variables, arithmetic, comparisons, functions and measures.
- [Solids reference](https://pegmatite.dev/guide/solids.md): Every primitive, the polyhedra, meshes and numbered faces.
- [Solid modifiers and edge selection](https://pegmatite.dev/guide/modifiers.md): Rotate, scale, flip, shell, cut, fillet, chamfer and edge selection.
- [Macros and conditionals](https://pegmatite.dev/guide/macros.md): Reusable solids and shapes, parameters, conditionals and recursion.
- [Patterns](https://pegmatite.dev/guide/patterns.md): Repeat, linear, circular, grid and mirror in full.
- [2D shapes](https://pegmatite.dev/guide/shapes.md): 2D profiles, regular polygons, SVG paths and faces as shapes.
- [2D operations and groups](https://pegmatite.dev/guide/shape-operations.md): Offset, round, fill, 2D transforms and shape groups with booleans.
- [Extrude and revolve](https://pegmatite.dev/guide/extrude.md): Every extrude option, and revolve.
- [Helix, sweep and varying profiles](https://pegmatite.dev/guide/sweeps.md): Helix, sweep along a path and varying profiles.
- [Text and fonts](https://pegmatite.dev/guide/text.md): Lettering, font size and fonts.
- [Tilings](https://pegmatite.dev/guide/tilings.md): Honeycomb, squares, triangles, stripes and Voronoi.
- [Check, preview and export with the CLI](https://pegmatite.dev/guide/cli.md): The check report, previews, export formats, fonts and exit codes.

## Tools and visual documentation

- [Editor](https://pegmatite.dev/editor): model live and export 3MF or STEP
- [Learn](https://pegmatite.dev/learn): illustrated lessons
- [Command reference](https://pegmatite.dev/docs): signatures and arguments
- [Use with AI agents](https://pegmatite.dev/agents): prompts and project setup
- [CLI](https://www.npmjs.com/package/pegmatite): Node.js 22+; check, render and export scripts

## Optional

- [Complete public guide](https://pegmatite.dev/llms-full.txt): all guide topics in one download
- [Formal grammar](https://pegmatite.dev/guide/grammar.ohm): exact parser grammar
- [Sample models](https://pegmatite.dev/models): gallery models and scripts