Provides a command line interface to the Alire configuration option files.
Option names (keys) can use lowercase and uppercase alphanumeric characters from the Latin alphabet.
Underscores and dashes can also be used except as first or last character. Dot '.' is used to specify
sub-categories, e.g. 'user.name' or 'user.email'. Option values can be integers, float, Boolean (true
or false) or strings. The type detection is automatic, e.g. 10 is integer, 10.1 is float, true is
Boolean. You can force a value to be set a string by using double-quotes, e.g. "10.1" or "true". Extra
type checking is used for built-in options (see below). Built-in configuration options:
index.auto_community[Boolean]
When unset (default) or true, the community index will be added automatically when required if no other
index is configured.
user.name[String]
User full name. Used for the authors and maintainers field of a new crate.
user.email[Emailaddress]
User email address. Used for the authors and maintainers field of a new crate.
user.github_login[GitHublogin]
User GitHub login/username. Used to for the maintainers-logins field of a new crate.
editor.cmd[String]
Editor command and arguments for editing crate code (alr edit). The executables and arguments are
separated by a single space character. The token ${GPR_FILE} is replaced by a path to the project file to
open.
msys2.do_not_install[Boolean]
If true, Alire will not try to automatically install msys2 system package manager. (Windows only)
msys2.install_dir[Absolutepath]
Directory where Alire will detect and/or install msys2 system package manager. (Windows only)
msys2.installer[String]
Filename of the executable msys2 installer, e.g. 'msys2-x86_64-20220319.exe'. (Windows only)
msys2.installer_url[String]
URL of the executable msys2 installer, e.g. 'https://github.com/msys2/msys2-
installer/releases/download/2022-03-19/msys2-x86_64-20220319.exe'. (Windows only)
update-manually-only[Boolean]
If true, Alire will not attempt to update dependencies even after the manifest is manually edited, or
when no valid solution has been ever computed. All updates have to be manually requested through `alr
update`
distribution.disable_detection[Boolean]
If true, Alire will report an unknown distribution and will not attempt to use the system package
manager.
solver.autonarrow[Boolean]
If true, `alr with` will replace 'any' dependencies with the appropriate caret/tilde dependency.
warning.caret[Boolean]
If true, Alire will warn about the use of caret (^) for pre-1 dependencies.
warning.old_index[Boolean]
When unset (default) or true, a warning will be emitted when using a compatible index with a lower
version than the newest known.
toolchain.assistant[Boolean]
If true, and assistant to select the default toolchain will run when first needed.