Skip to main content

OpenForma

Describe a physical system; generate its engineering domains.

OpenForma selects independently owned MechanicalIR, ElectricalIR, BiologicalIR, FluidicIR, ChemicalIR, ProcessIR and ThermalIR artifacts according to requested scope. The standard generation entry point returns portable artifacts, typed relationships, supported checks, assumptions and unresolved information. Existing HardwareIR projects keep their compatibility workflows.

See unified generation and the architecture audit for usage, the chemistry-first benchmark and explicit validation limits.

License: MPL 2.0 PyPI GitHub stars

Try Form · Browse projects · Run locally · Documentation

See it in action

Mechanical design and motion previews:

Hexapod walking Screw-driven arm Robotic 3D printer
Top view of a six-legged hexapod walking Screw-driven robotic arm approaching a part Robotic printer arm moving over a print bed

Watch the full walkthrough: designing a security camera →

Preview the security camera workflow

Form workflow creating a security camera

What you can build

  • CAD you can take with you. Preview mechanical designs in 3D and export STEP, STL, 3MF, and OBJ from supported native CAD builds.
  • Electronics with the details attached. Generate a bill of materials, interactive wiring diagrams, and assembly instructions. Rule-based checks flag shorts, voltage mismatches, pin conflicts, and other electrical issues.
  • Designs you can keep refining. Use follow-up instructions to change geometry, dimensions, placement, and requirements within an existing project.
  • Mechanisms you can inspect. Play, pause, and scrub supported joint-driven motion previews, including the two meshing gears example.
  • Machines you can control. Try the local Control Studio: keyboard/joystick inputs, an agent API, and a reusable multi-axis runtime demonstrated by a servo gate and two-axis XY stage.
  • Hardware workflows for your agents. Use Forma through the web app, Python package, CLI, or MCP. The shared skill works with OpenCode, Claude Code, Codex, OpenClaw, and NemoClaw.

Forma is an alpha research prototype for makers and developers. Electrical validation focuses on 3.3–5 V educational projects; CAD and motion previews still need engineering review before fabrication. See scope and validation.

Quick start

Use Form in your browser, or run it locally with OpenCode. Local authoring, validation, rendering, and project status do not require a Forma account.

Run locally with OpenCode

You need Python 3.11+, Node.js and npm (Node.js 22+ recommended), Git, and OpenCode with a working model connection. Your model provider's usage charges still apply.

macOS / Linux

curl --proto '=https' --tlsv1.2 -fsSL https://raw.githubusercontent.com/caid-technologies/Forma-OSS/main/scripts/development/install-opencode.sh | bash

Windows PowerShell

irm https://raw.githubusercontent.com/caid-technologies/Forma-OSS/main/scripts/development/install-opencode.ps1 | iex

The installer creates ~/forma-workspace, adds the Forma skill and MCP connection, installs missing app dependencies, and starts the backend and frontend. Keep that terminal open, then open a second terminal:

cd ~/forma-workspace
opencode mcp list
opencode

Try a first prompt:

Design a 3.3 V temperature monitor with an OLED display. Include a bill of materials, wiring, and an enclosure.

Open the local UI at localhost:3000. CAD generation and exports also require the native OpenCAD setup. For installation details and troubleshooting, see the setup guide.

Develop from source, use Docker, or install the Python core

Clone the repository and start the app:

git clone https://github.com/caid-technologies/Forma-OSS.git
cd Forma-OSS
./scripts/development/dev.sh

On Windows, replace the last command with .\scripts\development\dev.ps1.

The launcher starts the API and UI with local authentication and SQLite. Configure an agent connection or a model provider for live generation.

For Docker, run docker compose up --build from the repository root. See Docker setup for configuration and persistence.

For the reusable Python core and CLIs:

pip install openforma
forma-core --help
forma-oss --help

See the CLI and runtime reference for generation, iteration, local credentials, and cloud sync.

Publishing packages

This repository publishes its existing package identities from a GitHub Release:

  • openforma is built from the root pyproject.toml and published to PyPI.
  • @isayahc/forma-gui is built from packages/forma-gui and published to npm.

The Publish packages workflow validates both distributions before publishing. Configure the repository NPM_TOKEN secret and the PyPI trusted publisher for the pypi environment before creating a release. Update the package version in its own metadata, then publish a matching GitHub Release.

Install Forma for Cursor / Grok Bot

Install the Cursor plugin to discover the shared forma-hardware skill and local Streamable HTTP MCP connection. The guide covers local installation, protected cloud authentication, CLI-only use, and compatible Grok Bot deployments. Marketplace publication requires a separate maintainer submission and review; the repository includes the packaging and checklist.

How it works

  1. Describe the project. Start with requirements and optional reference images; refine the design through conversation.
  2. Author a structured design. An agent produces Hardware Intermediate Representation, Forma's typed, versioned representation of components, connections, geometry, and project history.
  3. Compile and inspect. Forma validates the design and produces schematics, previews, and supported CAD artifacts. Iterate on the saved project as your requirements change.

With the local agent workflow, your host agent supplies the model and Forma performs deterministic compilation. The reusable forma_core package also supports server-side generation. See architecture and agent integrations.

Go deeper

I want to… Start here
Install or self-host Form Setup · CLI and runtime reference
Connect my own agent Agent integrations · Model and image configuration
Understand the project format Hardware Intermediate Representation · Architecture
Explore examples and motion Examples · Gear motion preview
Reconstruct CAD history in Onshape, NX, or Fusion AI-assisted CAD migrations
Contribute or evaluate results Contributing · Development · Evaluations

All documentation · Roadmap · Report a bug

Build with us

Try a design, share what worked, or help improve CAD generation, validation, examples, and the interface. Read CONTRIBUTING.md for the contribution workflow.

If you want open-source hardware design to be easier, star Forma to follow its progress and help other builders find it.

Built by Caid Technologies. Licensed under the Mozilla Public License 2.0.

Citation

If you use Forma-OSS in research, publications, or other academic work, please cite the project:

@software{mapped_assembly_forma_oss_2026,
  author = {{Mapped Assembly}},
  title = {Forma-OSS: Open-source AI hardware design workspace},
  year = {2026},
  url = {https://github.com/Mapped-Assembly/forma-oss},
  note = {Open-source software}
}

Metadata

Release files for openforma 0.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for openforma 0.4.0
File Size Uploaded Provenance Actions
openforma-0.4.0.tar.gz 690.0 kB Without provenance Details for openforma-0.4.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for openforma 0.4.0
File Interpreter ABI Platform Actions
openforma-0.4.0-py3-none-any.whl Python 3 none any Details for openforma-0.4.0-py3-none-any.whl

Total release size: 1.5 MB

Release files / openforma-0.4.0.tar.gz

Download URL openforma-0.4.0.tar.gz
Size 690.0 kB
Tags Source
SHA-256 checksum
How to use checksums
585c072568a717f5383182f4184626fe63bf01f49d20c4e9a4c1349f24acb541
BLAKE2b-256 checksum
How to use checksums
e6b1505d996aeead39a899f3868c87c216f9e6354ccbe163495111114cc1cb1f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.3

Release files / openforma-0.4.0-py3-none-any.whl

Download URL openforma-0.4.0-py3-none-any.whl
Size 808.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d86aecc07fc6d842f892611285ccd4f793c119df0235bc3e042b0391c7b99a92
BLAKE2b-256 checksum
How to use checksums
c499f7fb545369e7f72abd81d9f42e73ee409785f4801fd8c64d067423da0c5f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.3

Security for openforma 0.4.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.4.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page