Getting Started

Getting Started

Install

Python 3.10 to 3.13:

pip install "wireforge[server,mcp,import]"

Building generated code needs a C++17 compiler, CMake 3.21+ and Ninja or Make.

First project

wireforge init demo --template telemetry     # also: command, raw
wireforge validate demo
wireforge test demo -o build/demo            # generate, build and run the tests

Change the names, fields and limits in demo/project.yaml to match your protocol, then run the same commands again. Add --language c to generate or test to get C99 instead of C++17.

Starting from a published protocol instead: wireforge init gps --protocol ubx (see Protocol Library).

Next

• Full walkthrough: docs/GUIDE.md
• All commands and the Python API: docs/CLI.md
• Definition format: docs/SCHEMA_SPEC.md
• What gets generated: docs/CODEGEN.md