Config file reference

By default the config file is searched in the current directory using the following regular expressions:

• ^\.?(config|conf)[-\._]?freeports\.ya?ml$

• ^\.?freeports[-\._]?(config|conf)\.ya?ml$

Tip

Our preferred way of calling the config file are:

• config.freeports.yaml

• freeports.conf.yaml

• freeports-config.yaml

If not present it fallback conforming to XDG Base Directory Specification (usually to ~/.config) and search for a freeports.yaml or freeports.yml file. If no configuration is found last attempt is to system wise configuration file (/etc/freeports.yaml or /etc/freeport.yml).

Note

In Windows systems the check on XDG base directories is substitute with %LOCALAPPDATA% (fallback to ~\\AppData\\Local) or %PROGRAMDATA% (fallback to C:\\ProgramData). The check to system wise configuration is done on %SystemRoot% (fallback to C:\\Windows).

The map between command line config file variables and options is: