64bit unsigned integers must be represented as strings!This is due to a limitation in JSON/JavaScript
| Option value | transport = "fs" | transport = "env" |
|---|
| (binary, big-endian) | (utf8) |
Full example
[options.EXAMPLE_U64_OPTION]
type = "u64"
required = false
default = 50000
display.label = "Example u64 Option"
display.description = "This is an example u64 option."
display.group = "Example Group"
# If variants are defined, min/max should not be defined
# validation.variants = [0, 25000, 50000, 75000, 100000]
validation.min = 0
validation.max = 100000
[options.EXAMPLE_U64_OPTION]
type = "list[u64]"
required = false
default = [0, 50000, 100000]
display.label = "Example u64 List Option"
display.description = "This is an example u64 list option."
display.group = "Example Group"
# If variants are defined, min/max should not be defined
# validation.variants = [0, 25000, 50000, 75000, 100000]
validation.min = 0
validation.max = 100000
option.type
required
option.default
optional
A string specifying the default value for this option. If this is
specified, setting required = true will have no effect. An array of strings specifying the
default values for this option. If this is specified, setting required = true will have no effect.default = ["1000", "2000", "3000"]
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.
option.validation
The server performs option validation before running an agent. The Coral server will never launch an agent with option
values that do not pass the validation rules given for an option.
The absence of a validation rule indicates that the absent validation rule should not be performed. No validation rules
have default values.
For list types, validation will be performed on each item on the list. A single invalid item will reject the entire list.
option.validation.variants
optional
An array of strings that specify valid
values for this option. If variants is specified, the value for this option must be one of the entries in variants.
This is usually used to construct an enum.
validation.variants = ["1", "2", "3"]
option.validation.min
optional
A string specifying the minimum allowed value for this option.
option.validation.max
optional
A string specifying the maximum allowed value for this option.
option.transport
default env
optional
Controls how the option value is sent to the agent.
Environment transport
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
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"
