commands.md

Command reference

dau-build installs one console script (entry point dau_build.cli:main). It runs typed ccflow.CallableModels composed from the Hydra config tree in dau_build/config.

dau-build [--config-dir DIR] [--explain] <overrides ...>

Option / argument	Description
--config-dir DIR	A user config overlay directory. Its groups are merged into the tree.
--explain	Print the fully resolved config as YAML and exit without running.
overrides	Hydra overrides, described below.

Overrides

Every argument after the options is a Hydra override:

Form	Selects	Example
task=<path>	the task to run (populates model)	task=tasks/sim/simulate
<group>=<option>	a config group option: spec=, board=, backend=, simulator=, design=, plan=, platform=	backend=backends/yosys
model.<field>=value	a field on the selected task model	model.output_root=out

Task and group option names are paths into the config tree (task=tasks/sim/simulate, backend=backends/yosys). Short names such as task=simulate are not accepted.

dau-build exits with an error if task= is not given, since nothing then populates model.

The task names and their fields are in the task and step catalog. The groups selectable with spec=, board=, backend= and platform= are in the config group reference.

Examples

Inspect, build and validate a spec or generated bundle:

dau-build task=tasks/spec/inspect  spec=specs/identity
dau-build task=tasks/spec/build     spec=specs/identity model.output_root=outputs/identity
dau-build task=tasks/spec/validate  model.manifest_path=outputs/identity/dau-identity.manifest model.root=outputs/identity

Select a config group, here the yosys synthesis backend instead of the default Vivado engine:

dau-build task=tasks/build/synthesize spec=specs/identity backend=backends/yosys model.module=dau_identity_top model.output_root=out

Show what a set of overrides composes to, without running:

dau-build --explain task=tasks/build/synthesize spec=specs/identity backend=backends/yosys

Composition across packages

The Hydra search path is active, so config groups registered by other installed packages (through their own hydra.lernaplugins entry point) compose alongside the packaged ones with no --config-dir overlay. With the dau package installed, for example, dau-build task=shell design=designs/bar-noc resolves a task defined in dau's config tree. A --config-dir DIR overlay adds ad-hoc task configs (and new _target_ models from any importable package) the same way. See Extending dau-build.