Command line¶
wiz¶
Wiz is an environment management framework which resolves an environment context or executes a command from one or several package requests.
Example:
A command can also be executed from a resolved context via a command alias which is extracted from its corresponding package.
Example:
All available packages and command can be listed as follow:
It is also possible to search a specific package or command as follow:
wiz [OPTIONS] COMMAND [ARGS]...
Options
-
--version¶ Show the version and exit.
-
-v,--verbosity<verbosity>¶ Set the logging output verbosity.
Default: info Options: debug | info | warning | error
-
--no-local¶ Skip local registry.
-
--no-cwd¶ Do not attempt to discover definitions from current working directory within project.
-
-rd,--registry-depth<NUMBER>¶ Maximum depth to recursively search for definitions.
-
-r,--registry<PATH>¶ Set registry path for package definitions.
Default:
-
-add,--add-registry<PATH>¶ Prepend registry path to default registries.
-
--ignore-implicit¶ Do not include implicit packages (with ‘auto-use’ set to true) in resolved context.
-
--init<VARIABLE=VALUE>¶ Initial Environment which will be augmented by the resolved environment.
-
--platform<PLATFORM>¶ Override detected platform.
-
--architecture<ARCHITECTURE>¶ Override detected architecture.
-
--os-name<NAME>¶ Override detected operating system name.
-
--os-version<VERSION>¶ Override detected operating system version.
-
--record<record>¶ Record resolution context process for debugging.
analyze¶
Analyze reachable definitions and display corresponding errors and warnings. A filter can be set to target specific definitions.
Example:
wiz analyze [OPTIONS] [FILTERS]...
Options
-
-d,--duration-threshold<SECONDS>¶ Update duration threshold (in seconds)
-
-e,--extraction-threshold<NUMBER>¶ Update combination extraction threshold
-
-mc,--max-combinations<NUMBER>¶ Maximum number of combinations which can be generated from conflicting variants during the context resolution process.
Default: 10
-
-ma,--max-attempts<NUMBER>¶ Maximum number of attempts to resolve the context before raising an error.
Default: 15
-
-V,--verbose¶ Increase verbosity of analysis.
Arguments
-
FILTERS¶ Optional argument(s)
edit¶
Edit one or several definitions with default editor or with operation option(s).
If an output is specified, the original definition(s) will not be mutated. Otherwise, the original definition file(s) will be updated with edited data.
The edited definition(s) will be validated before export.
Example:
wiz edit [OPTIONS] DEFINITIONS...
Options
-
--set<KEYWORD VALUE>¶ Set a new value to a keyword.
-
--update<KEYWORD VALUE>¶ Update mapping keyword with mapping value.
-
--extend<KEYWORD VALUE>¶ Extend list keyword with list value.
-
--insert<KEYWORD VALUE INDEX>¶ Insert value to keyword with.
-
--remove<KEYWORD>¶ Remove keyword.
-
--remove-key<KEYWORD NAME>¶ Remove value from mapping keyword.
-
--remove-index<KEYWORD INDEX>¶ Remove index from list keyword.
-
-f,--overwrite¶ Always overwrite existing definitions.
-
-o,--output<output>¶ Indicate an output directory for updated definition(s). By default, original definition will be modified.
Arguments
-
DEFINITIONS¶ Required argument(s)
freeze¶
Export resolved context into a package definition or a script.
Example:
wiz freeze [OPTIONS] REQUESTS...
Options
-
-o,--output<output>¶ Required Indicate the output directory.
-
-F,--format<format>¶ Indicate the output format.
Default: wiz Options: wiz | tcsh | bash
Arguments
-
REQUESTS¶ Required argument(s)
install¶
Install a package definition to a registry.
Example:
wiz install [OPTIONS] DEFINITIONS...
Options
-
-o,--output<output>¶ Required Registry target to install the package to.
-
-f,--overwrite¶ Always overwrite existing definitions.
Arguments
-
DEFINITIONS¶ Required argument(s)
list¶
Display all available commands or package definitions.
Example:
wiz list [OPTIONS] COMMAND [ARGS]...
run¶
Run command from resolved context.
Example:
wiz run [OPTIONS] REQUEST
Options
-
--view¶ Only view the resolved context without loading it.
-
-mc,--max-combinations<NUMBER>¶ Maximum number of combinations which can be generated from conflicting variants during the context resolution process.
Default: 10
-
-ma,--max-attempts<NUMBER>¶ Maximum number of attempts to resolve the context before raising an error.
Default: 15
Arguments
-
REQUEST¶ Required argument
search¶
Search and display definitions from a list of filters.
Example:
wiz search [OPTIONS] FILTERS...
Options
-
-a,--all¶ Display all package versions, not just the latest one.
-
--no-arch¶ Display results for all platforms.
-
-t,--type<type>¶ Set the request type.
Default: all Options: all | package | command
Arguments
-
FILTERS¶ Required argument(s)
use¶
Spawn shell with resolved context from requested packages, or run a command within the resolved context.
Example:
wiz use [OPTIONS] REQUESTS...
Options
-
--view¶ Only view the resolved context without loading it.
-
-mc,--max-combinations<NUMBER>¶ Maximum number of combinations which can be generated from conflicting variants during the context resolution process.
Default: 10
-
-ma,--max-attempts<NUMBER>¶ Maximum number of attempts to resolve the context before raising an error.
Default: 15
Arguments
-
REQUESTS¶ Required argument(s)