Commands¶
Command Line Interface¶
CLI Interface to the Maloja toolkit.
Operation via CLI requires a set of common options. Each subcommand may have extra options, like this:
maloja <common options> SUBCOMMAND <subcommand options>
usage: maloja [-h] [--version] [-v] [--log LOG_PATH] --url URL --user USER
[--output OUTPUT]
{survey,plan,build,inspect} ...
- Options:
--version Print the current version number -v, --verbose Increase the verbosity of output --log Set a file path for log output --url URL to API endpoint --user Registered user for API access --output path to output directory [C:\Users\User\.maloja] - Sub-commands:
- survey
Maloja ‘survey’ command.
Invokes the surveyor module to map your virtual infrastructure.
usage: maloja survey [-h]
- plan
Maloja ‘plan’ command.
Invokes the planner module to check a design file.
usage: maloja plan [-h] --input INPUT
- Options:
--input path to design file
- build
Maloja ‘build’ command.
Invokes the builder module to create virtual infrastructure.
usage: maloja build [-h] --input INPUT
- Options:
--input path to design file
- inspect
Maloja ‘inspect’ command.
Invokes the inspector module to check virtual infrastructure.
usage: maloja inspect [-h] --input INPUT --name NAME
- Options:
--input path to design file --name name of object for inspection
Console¶
The console launches when you invoke Maloja without a subcommand. It provides an interactive environment and a help facility:
Type 'help' for commands > help
Documented commands (type help <topic>):
========================================
clear help plugin quit search survey
Type 'help' for commands > help plugin
'Plugin' lists plugins and their availability. Supply
a number from that menu to invoke the plugin.
> plugin
(a list will be shown)
> plugin 2
Use the console for long-running tasks which require your attention or intervention.
The commands available from the console are:
- help
- survey
- search
- clear
- plugin
- quit