Input
objectA description of the input, which clients can use to provide context to the user.
Default:false
Specifies the input format. Supported values include filepath, which should be interpreted as a file on the user’s filesystem.
When the input is converted to a string, booleans should be represented by the strings “true” and “false”, and numbers should be represented as decimal values.
Allowed values:stringnumberbooleanfilepath
Default:string
The value for the input. If this is not set, the user may be prompted to provide a value. If a value is set, it should not be configurable by end users.
Identifiers wrapped in {curly_braces} will be replaced with the corresponding properties from the input variables map. If an identifier in braces is not found in variables, or if variables is not provided, the {curly_braces} substring should remain unchanged.
Indicates whether the input is a secret value (e.g., password, token). If true, clients should handle the value securely.
Default:false
The default value for the input. This should be a valid value for the input. If you want to provide input examples or guidance, use the placeholder field instead.
A placeholder for the input to be displaying during configuration. This is used to provide examples or guidance about the expected form or content of the input.
A list of possible values for the input. If provided, the user must select one of these values.
Example:[]
InputWithVariables
A description of the input, which clients can use to provide context to the user.
Default:false
Specifies the input format. Supported values include filepath, which should be interpreted as a file on the user’s filesystem.
When the input is converted to a string, booleans should be represented by the strings “true” and “false”, and numbers should be represented as decimal values.
Allowed values:stringnumberbooleanfilepath
Default:string
The value for the input. If this is not set, the user may be prompted to provide a value. If a value is set, it should not be configurable by end users.
Identifiers wrapped in {curly_braces} will be replaced with the corresponding properties from the input variables map. If an identifier in braces is not found in variables, or if variables is not provided, the {curly_braces} substring should remain unchanged.
Indicates whether the input is a secret value (e.g., password, token). If true, clients should handle the value securely.
Default:false
The default value for the input. This should be a valid value for the input. If you want to provide input examples or guidance, use the placeholder field instead.
A placeholder for the input to be displaying during configuration. This is used to provide examples or guidance about the expected form or content of the input.
A list of possible values for the input. If provided, the user must select one of these values.
Example:[]
A map of variable names to their values. Keys in the input value that are wrapped in {curly_braces} will be replaced with the corresponding variable values.
PositionalArgument
A positional input is a value inserted verbatim into the command line.
Any OfA description of the input, which clients can use to provide context to the user.
Default:false
Specifies the input format. Supported values include filepath, which should be interpreted as a file on the user’s filesystem.
When the input is converted to a string, booleans should be represented by the strings “true” and “false”, and numbers should be represented as decimal values.
Allowed values:stringnumberbooleanfilepath
Default:string
The value for the input. If this is not set, the user may be prompted to provide a value. If a value is set, it should not be configurable by end users.
Identifiers wrapped in {curly_braces} will be replaced with the corresponding properties from the input variables map. If an identifier in braces is not found in variables, or if variables is not provided, the {curly_braces} substring should remain unchanged.
Indicates whether the input is a secret value (e.g., password, token). If true, clients should handle the value securely.
Default:false
The default value for the input. This should be a valid value for the input. If you want to provide input examples or guidance, use the placeholder field instead.
A placeholder for the input to be displaying during configuration. This is used to provide examples or guidance about the expected form or content of the input.
A list of possible values for the input. If provided, the user must select one of these values.
Example:[]
A map of variable names to their values. Keys in the input value that are wrapped in {curly_braces} will be replaced with the corresponding variable values.
Allowed values:positional
Example:positional
An identifier for the positional argument. It is not part of the command line. It may be used by client configuration as a label identifying the argument. It is also used to identify the value in transport URL variable substitution.
Example:file_path
Whether the argument can be repeated multiple times in the command line.
Default:false
NamedArgument
A command-line --flag={value}.
A description of the input, which clients can use to provide context to the user.
Default:false
Specifies the input format. Supported values include filepath, which should be interpreted as a file on the user’s filesystem.
When the input is converted to a string, booleans should be represented by the strings “true” and “false”, and numbers should be represented as decimal values.
Allowed values:stringnumberbooleanfilepath
Default:string
The value for the input. If this is not set, the user may be prompted to provide a value. If a value is set, it should not be configurable by end users.
Identifiers wrapped in {curly_braces} will be replaced with the corresponding properties from the input variables map. If an identifier in braces is not found in variables, or if variables is not provided, the {curly_braces} substring should remain unchanged.
Indicates whether the input is a secret value (e.g., password, token). If true, clients should handle the value securely.
Default:false
The default value for the input. This should be a valid value for the input. If you want to provide input examples or guidance, use the placeholder field instead.
A placeholder for the input to be displaying during configuration. This is used to provide examples or guidance about the expected form or content of the input.
A list of possible values for the input. If provided, the user must select one of these values.
Example:[]
A map of variable names to their values. Keys in the input value that are wrapped in {curly_braces} will be replaced with the corresponding variable values.
Allowed values:named
Example:named
The flag name, including any leading dashes.
Example:--port
Whether the argument can be repeated multiple times.
Default:false
KeyValueInput
A description of the input, which clients can use to provide context to the user.
Default:false
Specifies the input format. Supported values include filepath, which should be interpreted as a file on the user’s filesystem.
When the input is converted to a string, booleans should be represented by the strings “true” and “false”, and numbers should be represented as decimal values.
Allowed values:stringnumberbooleanfilepath
Default:string
The value for the input. If this is not set, the user may be prompted to provide a value. If a value is set, it should not be configurable by end users.
Identifiers wrapped in {curly_braces} will be replaced with the corresponding properties from the input variables map. If an identifier in braces is not found in variables, or if variables is not provided, the {curly_braces} substring should remain unchanged.
Indicates whether the input is a secret value (e.g., password, token). If true, clients should handle the value securely.
Default:false
The default value for the input. This should be a valid value for the input. If you want to provide input examples or guidance, use the placeholder field instead.
A placeholder for the input to be displaying during configuration. This is used to provide examples or guidance about the expected form or content of the input.
A list of possible values for the input. If provided, the user must select one of these values.
Example:[]
A map of variable names to their values. Keys in the input value that are wrapped in {curly_braces} will be replaced with the corresponding variable values.
Name of the header or environment variable.
Example:SOME_VARIABLE