Configuration¶
File¶
The Makex configuration file allows one to override some aspects of Makex. A configuration file is not required to use Makex.
The configuration file itself may be located in several places:
The user’s configuration directory (
~/.config/makex/makex.toml).The global/system configuration directory (
/etc/makex/makex.toml)
These locations are checked in order, and the configuration is merged with the same precedence.
Sections¶
makex¶
toml configuration files are specified with sections. makex is the primary section to configure Makex.
- makex¶
The root section.
- shell: string | None
Warning
Changing this value may make your Makex files incompatible with others. It’s best to not touch this unless you know what you are doing. This option may be removed in the future.
The shell that should be used when running the shell() action and anything else using a shell.
Set to a string/path of the shell you want to use (e.g. /bin/sh).
Leave empty to automatically detect from the running shell (or use the system shell).
It’s recommended to use the most simple shell possible (and one that is compatible with the expand() function). The Shell Command Language of /bin/sh as defined in the Posix Standard is typically recommended and detected.
Default is null to autodetect.
Environment Variables¶
Environment variables override some aspects of Makex.
- WORKSPACE¶
The path of the current Workspace. See the Workspaces documentation for more information.
- PATH¶
On POSIX/Unix/Linux, this is used to resolve the paths of executables.