Configuration options

dpm can be configured via (simultaneously):

• config file: ${DPM_HOME}/dpm-config.yaml

• environment variables: which take precedence over similar fields in dpm-config.yaml

Additionally, DPM (and DPM’s installation process) make use of the system’s default temp directory. On Unix systems, it uses $TMPDIR if non-empty, else /tmp. On Windows, it uses GetTempPath, returning the first non-empty value from %TMP%, %TEMP%, %USERPROFILE%, or the Windows directory.

Multi-package Configuration file (multi-package.yaml)

The multi-package.yaml file is used to inform Daml Build and the IDE of projects containing multiple connected Daml packages.

An example is given below:

packages:
  - ./path/to/package/a
  - ./path/to/package/b

packages: an optional list of directories containing Daml packages, and by extension, daml.yaml config files. These allow Daml Multi-Build to find the source code for dependency DARs and build them in topological order.

You can also specify the sdk-version: field in multi-package.yaml. This SDK version applies to all packages in the multi-package, unless a package’s individual daml.yaml specifies its own sdk-version, which takes precedence over the one in multi-package.yaml.

sdk-version: 3.4.11
packages:
  - ./path/to/package/a
  - ./path/to/package/b

The multi-package also includes an optional dars field, for providing additional information to Daml Studio. See Daml Studio Jump to definition for more details.

Environment Variable Interpolation

Both the daml.yaml and multi-package.yaml config files support environment variable interpolation on all string fields. Interpolation takes the form of ${MY_ENVIRONMENT_VARIABLE}, which is replaced with the content of MY_ENVIRONMENT_VARIABLE from the calling shell. These can be escaped and placed within strings according to the environment variable interpolation semantics.

This allows you to extract common data, such as the sdk-version, package-name, or package-version outside of a package’s daml.yaml. For example, you can use an .envrc file or have these values provided by a build system. This feature can also be used for specifying dependency DARs, enabling you to either store your DARs in a common folder and pass its directory as a variable, shortening the paths in your daml.yaml, or pass each dependency as a separate variable through an external build system, which may store them in a temporary cache.

The following example showcases this:

sdk-version: ${SDK_VERSION}
name: ${PROJECT_NAME}_test
source: daml
version: ${PROJECT_VERSION}
dependencies:
  // Using a common directory
  ${DEPENDENCY_DIRECTORY}/my-dependency-1.0.0.dar
  ${DEPENDENCY_DIRECTORY}/my-other-dependency-1.0.0.dar
  // Passed directly by a build system
  ${DAML_FINANCE_DAR}
  ${MY_DEPENDENCY_DAR}

Escape syntax uses the \ prefix: \${NOT_INTERPOLATED}.

Additionally, if you specify the sdk-version in the multi-package.yaml that references your project daml.yaml, you can exclude repeating the sdk-version: field in your daml.yaml, and the value specified in your multi-package.yaml will be used.

Additionally, you can avoid specifying an sdk-version entirely and only opt-in to particular components, as outlined in the examples below.

Opt-in Components

dpm supports opting in to the components in a single and/or a multi-package project instead of relying on an sdk-version bundle.

You can use pre-existing components, or components you create and publish to extend the CLI (see Publishing your own custom component).

# daml.yaml

components:
  # damlc pre-existing component at version 3.5.1-rc1
  - damlc:3.5.1-rc1

  # custom component "foo" from an external registry
  - oci://example.com/some/path/foo:1.2.3

  # a codegen-python component present locally on the filesystem
  - name: codegen-python
    path: ../path/to/component/directory

# multi-package.yaml

packages:
  - ./daml-pkg-1
  - ./daml-pkg-2

components:
  - damlc:3.5.1-rc1

  # adding component "foo"
  - oci://example.com/some/path/foo:1.2.3

  # component present locally on the filesystem
  - name: codegen-java
    path: ../path/to/component/directory

dpm install package