vibe.core.args

Parses and allows querying the command line arguments and configuration file.

The optional configuration file (vibe.conf) is a JSON file, containing an object with the keys corresponding to option names, and values corresponding to their values. It is searched for in the local directory, user's home directory, or /etc/vibe/ (POSIX only), whichever is found first.

Members

Enums

isOptionValue
eponymoustemplate isOptionValue(T)

Tests if a given type is supported by readOption.

Functions

finalizeCommandLineOptions
bool finalizeCommandLineOptions(string[]* args_out)

Checks for unrecognized command line options and display a help screen.

printCommandLineHelp
void printCommandLineHelp()

Prints a help screen consisting of all options encountered in getOption calls.

readOption
bool readOption(string names, T* pvalue, string help_text)

Finds and reads an option from the configuration file or command line.

readRequiredOption
T readRequiredOption(string names, string help_text)

The same as readOption, but throws an exception if the given option is missing.

setCommandLineArgs
void setCommandLineArgs(string[] args)

This functions allows the usage of a custom command line argument parser with vibe.d.

Meta

License

Subject to the terms of the MIT license, as written in the included LICENSE.txt file.

Authors

Sönke Ludwig, Vladimir Panteleev