Skip to content
serialseb edited this page Dec 26, 2010 · 3 revisions

Commanding system

Most of OpenWrap's functionality is available through a variety of commands.

Getting help

You can get the list of commands at any time by reading the command help.

$ o get-help

The get-help command can also display help for a specific command.

$ o get-help verb-noun

Structure of a command

Commands have a noun and a verb, similar to PowerShell commands, and take a bunch of input parameters.

Executing commands through the Shell

When using the o.exe shell, you can call a command using one of two notations.

$ o noun verb
$ o verb-noun

For example, to access the help for existing commands, both get-help and help get can be used.

The shell also supports partial naming. Provided only one name and verb are matching, the command can be typed as h g or any other parts of the names.

Parameters

Most commands also take input parameters. For example, the documentation for the add-wrap command is as follow.

        add-wrap [-Name] <String> [[-Version] <String>] [-Anchored <Boolean>] [-Content <Boolean>] [-MaxVersion <String>] [-MinVersion <String>] [-NoDescriptorUpdate <Boolean>] [-Project <Boolean>] [-System <Boolean>]

Clone this wiki locally