DevSpace allows you to define certain requirements that must be met to use DevSpace for a certain project. This is useful if you want to ensure that all developers that use DevSpace in a project have a certain DevSpace version, specific plugins or commands installed. You can define one or multiple of:
- DevSpace Version (
require.devspace): You can define a required DevSpace version
- Installed Plugins (
require.plugins): You can define required plugins and their version
- Installed Commands (
require.commands): You can define arbitrary commands such as
helmthat need to be present locally in a specific version or range
Requirements are defined in the
require section of the
- DevSpace Version
# You can either specify an exact version or a version range or even
# multiple versions.
devspace: '>= 4.0, < 6.0'
# Each plugin that is defined under plugins needs to be installed
# in the required version.
- name: loft
version: ">= 1.11.0"
# By default devspace will try to call the command 'NAME version'
# and use the regex '(v\\d+\\.\\d+\\.\\d+)' to find the version
- name: helm
version: '> 3.0.0'
- name: my-custom-command
# Override the default args
# Override the default reg ex
versionRegEx: "Version: (v?\\d+\\.\\d+\\.\\d+)"
Require defines what DevSpace, plugins and command versions are required to use this config and if a condition is not
fulfilled, DevSpace will fail.
devspace required string
DevSpace specifies the DevSpace version constraint that is needed to use this config
commands required object
Commands specifies an array of commands that need to be installed locally to use this config
name required string
Name is the name of the command that should be installed
versionArgs required string
VersionArgs are the arguments to retrieve the version of the command
versionRegEx required string
VersionRegEx is the regex that is used to parse the version
version required string
Version constraint of the command that should be installed