Skip to content
You're reading the docs for DRE 0.4 (v0.4.4). This page for 0.5 · New in 0.5

dependencies.yml reference

Plugin packages and macro packages, in dependencies.yml or packages.yml at the project root.

Where: dependencies.yml or packages.yml.

For editor autocomplete and validation, add this as the first line of the file (editor setup):

# yaml-language-server: $schema=https://getdre.com/schemas/v0.4/dependencies.schema.json

For copyable examples and common errors, see Plugin and macro packages. The glossary defines DRE’s terms.

Key Type Default Description
plugins list of plugin packages: a name, name: "<version>", or a map (see below) The plugin packages this project uses. DRE installs them on demand into dre_deps/ and pins them in dre.lock. May be written in any project YAML file; dependencies.yml is the usual place.
extensions list of map (see below) [] Optional separately licensed companion executables. dre deps offers to install them (or --accept-proprietary); ordinary report commands do not. Pin each binary version and review its own licence separately.
packages list of any Macro packages (git or local). Their macros are called through the package name, e.g. {{ dre_utils.star(...) }}. Exact commits are pinned in dre.lock.

A package with its source.

Key Type Default Description
name (required) string The package name: lowercase letters, digits and _.
version string A version constraint such as 1.2.0 or >=1.0. Not allowed with local.
github string Install from the releases of this GitHub repository, owner/repo.
local string Use the package folder at this path as it is.
registry string Install from this registry index (a URL or a path) instead of the default one.

An optional companion dependency, separate from source/format/destination plugins. Keys besides name and version are the companion’s own settings: DRE passes them through and the companion checks them.

Key Type Default Description
name (required) string Registry executable name, e.g. dre-mcp.
version (required) string Exact semantic version, including an RC suffix where applicable.
other keys Settings of the companion itself, which reads and checks them; see its documentation.

A macro package, from git or from a folder.

Key Type Default Description
git string The git URL of the package. Needs revision.
revision string A tag, branch or commit of the git package.
local string The path of a package folder in this project’s tree.