Skip to main content
A boolean option. Booleans should use the environment transport as they are never large enough to use the filesystem transport.
Booleans do not have a list type
Option valuetransport = "fs"transport = "env"
true0x011
false0x000
(binary)(utf-8 string)

​
Full example

[options.EXAMPLE_BOOL_OPTION]
type = "bool"
required = false
default = true

display.label = "Example Boolean Option"
display.description = "This is an example boolean option."
display.group = "Example Group"

​
option.type

required 
type = "bool"

​
option.default

optional A boolean specifying the default value for this option. 
default = true

​
option.required

default false
optional If required = true this option is not optional and must be specified. Setting required = true for an option that has a default value has no effect. 
required = true

​
option.transport

default env
optional Controls how the option value is sent to the agent.

​
Environment transport

transport = "env"
The environment transport will send the option value to the agent via an environment variable. The name of the environment variable will match the option name, and the value will be encoded in UTF-8. For lists, multiple values will be sent delimited by a comma ,. It is recommended to use option.base64 = true when there is a chance the value will contain a comma.

​
Filesystem transport

transport = "fs"
The filesystem transport will send the option value to the agent via a file. An environment variable matching the name of this option will be sent to the agent, the value of the environment variable will be the path to the file that contains the value for the option. For lists, multiple files will be created. A list of paths will be provided in the environment variable, delimited by either:
  • ; on Windows
  • : on Unix-like operating systems

​
option.display

Display options are used to configure how the option should render in the Coral console. They may also be used in other third-party interfaces.

​
option.display.label

optional A string literal specifying the label for this option. Coral console will display this label instead of the option’s name if it is specified. 
display.label = "My option"

​
option.display.description

optional A string literal specifying a description for this option. The description will appear as a tooltip for this option in the Coral console. 
display.description = "My option is used for ..."

​
option.display.group

optional A string literal specifying the group that this option belongs to. Options with the same group will appear grouped in the Coral console. 
display.group = "Prompts"