Command line interface
The tool Maike is launched from the command line. This page contains a list of all command line options that Maike accepts. An entity within square brackets is optional.
--help[=string]
Print this message to stdout
, or to the given file, and exit.
--load-path[=string]
Print the load path of the Maike executable to stdout
, or the given file, and exit.
--version[=string]
Print version information to stdout
, or to the given file, and exit.
--configclean
Do not load any system specific default configuration. In this mode, Maike will only load its build-in configuration, either followed by the file maikeconfig.json
, if present in the current directory, or the files listed in configfiles
. If the option configfiles
is given, maikeconfig.json
will not be loaded.
--configdump[=string]
Print the current configuration to stdout
, or to the given file, and exit.
--configfiles=string,...
Load the listed configuration files. If this argument is not given, Maike will instead load options from files maikeconfig.json
, found in system specific directories, and the current working,
--hooks-config=string,...
Set properties for the given target hooks. The string follows the syntax hook_name
:[JSON string without surrounding curly braces
].
--hooks-load=string,...
Explicitly load the given target hooks. The string follows the syntax hook_plugin
:[filename_ext
,...]
--no-sysvars
Do not load any default system variables. This option is useful when using a cross-compiler. Normally, Maike loads a system-dependent set of variables that identifies the host platform.
--clean
Remove targets from disk. This option is like a conventional make clean
, with the addition that the affected targets can be controlled by the targets
option.
--list-all-targets[=string]
Print all targets to the given file and exit. As default, the data is written to stdout
.
--list-external-targets[=string]
Print all external targets to the given file and exit. As default, data is written to stdout
. External targets are targets not tracked by Maike--usually, they refer to external libraries.
--list-leaf-targets[=string]
Print all leaf targets to the given file and exit. As default, data is written to stdout
. A leaf target is a target that no other target refers to.
--remove-orphans
Remove targets not known by Maike, from disk. This option removes the complement to clean
targeting all targets.
--targets=string,...
Only process the listed targets. This option reduces the amount of output when using any of the --dump-* options.
--dump-database-json[=string]
Dump the internal database to a JSON file and exit. As default, the data is written to stdout
.
--dump-graph-dot[=string]
Dump the dependency graph to a DOT file and exit. As default, the data is written to stdout
.
--dump-graph-inv-dot[=string]
Dump an inverted dependency graph to a DOT file and exit. As default, the data is written to stdout
.
--dump-targets-tsv[=string]
Dumps information about the selected targets to a TSV (Tab Separated Values) file. As default, the data is written to stdout
.