Skip to main content

Variables

The following variables are available for string interpolation inside your project configuration files :

PathDescriptionExample
vars.*Custom variables, as declared in variables files or through the CLI.
project.rootAbsolute path to the project root directory.
"/home/me/workspace/my-project"
project.nameThe name of the project, as declared in your workspace configuration file.
"my-project"
workspace.rootAbsolute path to the workspace root directory. Use root instead.
workspace.nameThe name of the workspace
workspace.projectsProject references declared at the workspace level
{
  "project-1": {
    "path": "path/to/project-1"
  },
  "project-2": {
    "path": "path/to/project-2"
  }
}
workspace.projects.*.pathProject reference relative path, from the workspace root directory.
"path/to/project-1"
rootThe workspace root directory, as an absolute path.
"/path/to/my/workspace"
environment.*The current process environment variables (after loading all .env files).
{
  "HOME": "/home/user",
  "SHELL": "/bin/sh"
}
architectureThe current platform architecture. Possible values are listed here.
"x86_64"
familyThe operating system family. Can be either unix or windows.
"unix"
osThe specific current operating system. Possible values are listed here.
"linux"
userThe current user name.
"root"
hostnameThe current machine hostname. This variable can be unset in some cases.
sepFilesystem path component separator for the current platform
"/"