option — Declares configurable options for a command.


Some commands may be configurable through command-line options. Using one or more option tags within and command allows users to customize these options via the ReST GUI.


  • name (required) - The name to appear by the option during customization.

  • default (required) - The default value for this option. This is appended to the command after the truevalue (if type is not boolean. This may be an empty string.

  • type (required) - What type of substitution is this? Valid types are string (one line of text), choice (chosen from a list), boolean (true/false).

  • truevalue (required) - If type=boolean, this is the value to to append to the command. If type is not boolean then this will be appended to the command before the value input from the user. This can be an empty string.

  • falsevalue (required only if type=boolean) - The value to append if type is boolean and false is selected. This can be an empty string.

  • choices (required if type=choice) - A comma separated list of possbile choices for this option.

  • customChoice (optional) - If the type is choice and this attribute is set to true then the user may choose from the list of choices or give their own value for this option. If this attribute is false or not declared, the user is restricted to the given choices.

  • id (optional) - A unique id given to this option, which is used if option dependencies exist. Dependencies are not supported at this time.

  • depends (optional) - A comma-separated list of ids on which this option depends. Dependencies are not supported at this time.

  • enabled (optional) - If true this option will be turned on by default. If false or missing this option will be turned off by default.

  • description (optional) - A description of what this option does to the command.


The following elements are valid parents of option: command.


The following elements are children of option: No Children.


See command for an example of how to use options.