Reference

Core Commands

radbuild project create ./workspace --non-interactive --project-name demo
radbuild project create --list-templates
radbuild project create ./workspace --non-interactive --template fpga-mpsoc-buildroot --project-name demo
radbuild project create ./workspace --non-interactive --register --template radpx-os-terminal --project-name radpx-terminal
radbuild project register ./workspace/demo
radbuild project list --json
radbuild project unregister ./workspace/demo
radbuild project validate --settings ./workspace/demo/settings.json
radbuild graph --settings settings.json --json
radbuild host inspect --json
radbuild generate --settings settings.json
radbuild build fpga --settings settings.json --json-events
radbuild build os --settings settings.json --json-events
radbuild build all --settings settings.json --dry-run --json-events
radbuild deploy --settings settings.json --json-events

Schema Skeleton

{
  "radbuild_schema": "2.0",
  "radbuild_version": "0.2.2-beta.2",
  "project_name": "example",
  "systems": [],
  "connections": [],
  "artifacts": [],
  "deploy": [],
  "packages": {}
}

Host And Provider Execution

Projects may define host execution preferences when a provider can run either natively or through an adapter:

{
  "host": {
    "mode": "native"
  },
  "provider_execution": {
    "vivado": "native",
    "oss-cad-suite": "native",
    "radpx-os": "wsl"
  }
}

radbuild host inspect --json reports the current host kind and detected toolchains. Native Windows support in 0.2.2-beta.2 is focused on FPGA and light embedded flows. Linux-only OS providers intentionally refuse native Windows execution until the WSL provider mode is implemented end to end.

Common System Types

• fpga.vivado
• fpga.litex
• linux.petalinux
• linux.buildroot
• linux.yocto
• os.radpx
• software.native
• software.cross
• firmware.generic
• package.debian

Packaged Project Templates

• fpga-vivado
• fpga-mpsoc-petalinux
• fpga-mpsoc-buildroot
• fpga-linux-software
• radpx-os-terminal
• radpx-os-wm

Use radbuild project create --list-templates --json for machine-readable template metadata.

Project Registry

The project registry is a user-level list of RadBuild project roots shared by the CLI and VSCode extension. By default it lives at $XDG_CONFIG_HOME/radbuild/projects.json or ~/.config/radbuild/projects.json. Set RADBUILD_PROJECT_REGISTRY=/path/to/projects.json for isolated testing or automation.

A registered project must point to a directory containing schema v2 settings.json, or directly to a JSON settings file.

VSCode Commands

• RadBuild: Projects opens the registered project table. Project rows expose

Open; project-specific settings, artifacts, and build actions appear after a project is active. If the target folder is already open, RadBuild activates the project without forcing a VSCode folder reload.

• RadBuild: Register Project Directory validates and registers a project root.
• RadBuild: Create Project creates from packaged templates and registers the

result. Switching templates resets defaults and disables non-applicable fields.

• RadBuild: Project Settings opens a form editor for common project fields,

systems, config values, and project toolchain selectors.

• RadBuild: Preview Build Plan runs radbuild vscode-events --dry-run and

shows ordered graph systems without invoking vendor toolchains.

• RadBuild: RadHDL Catalog opens a browser for catalog JSON/VHDL entries

reported by radbuild hdl catalog --json.

• RadBuild: Toolchains detects and stores common toolchain paths. Vivado and

PetaLinux register roots containing valid version directories and expose one selected active version. OSS CAD Suite, Gowin, GHDL, Yosys, nextpnr, QEMU, Buildroot, RadHDL, RadicalPackages, and cross compiler paths are tracked as explicit overrides.

• RadBuild: Build System builds a selected graph node; Build All builds the

active project graph.

RADPx/RADix-specific image configuration panels, QEMU launchers, serial-log filters, and packagegroup selectors are deferred while the OS interface remains in active development. OS projects still use the shared validate, generate, and build commands.

JSON Events

Build commands with --json-events emit line-delimited JSON for IDEs and automation. Consumers should read stdout one line at a time and treat unknown event fields as forward-compatible metadata.