CommandLineTool

This defines the schema of the CWL Command Line Tool Description document.

Members

Mixins

__anonymous
mixin genBody
Undocumented in source.

Static variables

class_
auto class_;

Variables

arguments_
Union!(None, Union!(string, Expression, CommandLineBinding)[]) arguments_;

Command line bindings which are not directly associated with input parameters.

baseCommand_
Union!(None, string, string[]) baseCommand_;

Specifies the program to execute. If an array, the first element of the array is the command to execute, and subsequent elements are mandatory command line arguments. The elements in baseCommand must appear before any command line bindings from inputBinding or arguments.

cwlVersion_
Union!(None, CWLVersion) cwlVersion_;

CWL document version. Always required at the document root. Not required for a Process embedded inside another Process.

doc_
Union!(None, string) doc_;

A long, human-readable description of this process object.

hints_
Union!(None, Union!(InlineJavascriptRequirement, SchemaDefRequirement, DockerRequirement, SoftwareRequirement, InitialWorkDirRequirement, EnvVarRequirement, ShellCommandRequirement, ResourceRequirement, SubworkflowFeatureRequirement, ScatterFeatureRequirement, MultipleInputFeatureRequirement, StepInputExpressionRequirement, Any)[]) hints_;

Declares hints applying to either the runtime environment or the workflow engine that may be helpful in executing this process. It is not an error if an implementation cannot satisfy all hints, however the implementation may report a warning.

id_
Union!(None, string) id_;

The unique identifier for this process object.

inputs_
CommandInputParameter[] inputs_;

Defines the input parameters of the process. The process is ready to run when all required input parameters are associated with concrete values. Input parameters include a schema for each parameter which is used to validate the input object. It may also be used to build a user interface for constructing the input object.

label_
Union!(None, string) label_;

A short, human-readable label of this process object.

outputs_
CommandOutputParameter[] outputs_;

Defines the parameters representing the output of the process. May be used to generate and/or validate the output object.

permanentFailCodes_
Union!(None, int[]) permanentFailCodes_;

Exit codes that indicate the process failed due to a permanent logic error, where executing the process with the same runtime environment and same inputs is expected to always fail.

requirements_
Union!(None, Union!(InlineJavascriptRequirement, SchemaDefRequirement, DockerRequirement, SoftwareRequirement, InitialWorkDirRequirement, EnvVarRequirement, ShellCommandRequirement, ResourceRequirement, SubworkflowFeatureRequirement, ScatterFeatureRequirement, MultipleInputFeatureRequirement, StepInputExpressionRequirement, Any)[]) requirements_;

Declares requirements that apply to either the runtime environment or the workflow engine that must be met in order to execute this process. If an implementation cannot satisfy all requirements, or a requirement is listed which is not recognized by the implementation, it is a fatal error and the implementation must not attempt to run the process, unless overridden at user option.

stderr_
Union!(None, string, Expression) stderr_;

Capture the command's standard error stream to a file written to the designated output directory.

stdin_
Union!(None, string, Expression) stdin_;

A path to a file whose contents must be piped into the command's standard input stream.

stdout_
Union!(None, string, Expression) stdout_;

Capture the command's standard output stream to a file written to the designated output directory.

successCodes_
Union!(None, int[]) successCodes_;

Exit codes that indicate the process completed successfully.

temporaryFailCodes_
Union!(None, int[]) temporaryFailCodes_;

Exit codes that indicate the process failed due to a possibly temporary condition, where executing the process with the same runtime environment and inputs may produce different results.

Mixed In Members

From mixin genBody

__anonymous
mixin genBody_!saladVersion
Undocumented in source.

Meta