github.com/solo-io/cue@v0.4.7/pkg/tool/exec/doc.go (about)

     1  // Code generated by cue get go. DO NOT EDIT.
     2  
     3  // Package exec defines tasks for running commands.
     4  //
     5  // These are the supported tasks:
     6  //
     7  //     // Run executes the given shell command.
     8  //     Run: {
     9  //     	$id: *"tool/exec.Run" | "exec" // exec for backwards compatibility
    10  //
    11  //     	// cmd is the command to run.
    12  //     	cmd: string | [string, ...string]
    13  //
    14  //     	// dir specifies the working directory of the command.
    15  //     	// The default is the current working directory.
    16  //     	dir?: string
    17  //
    18  //     	// env defines the environment variables to use for this system.
    19  //     	// If the value is a list, the entries mus be of the form key=value,
    20  //     	// where the last value takes precendence in the case of multiple
    21  //     	// occurrances of the same key.
    22  //     	env: [string]: string | [...=~"="]
    23  //
    24  //     	// stdout captures the output from stdout if it is of type bytes or string.
    25  //     	// The default value of null indicates it is redirected to the stdout of the
    26  //     	// current process.
    27  //     	stdout: *null | string | bytes
    28  //
    29  //     	// stderr is like stdout, but for errors.
    30  //     	stderr: *null | string | bytes
    31  //
    32  //     	// stdin specifies the input for the process. If stdin is null, the stdin
    33  //     	// of the current process is redirected to this command (the default).
    34  //     	// If it is of typ bytes or string, that input will be used instead.
    35  //     	stdin: *null | string | bytes
    36  //
    37  //     	// success is set to true when the process terminates with with a zero exit
    38  //     	// code or false otherwise. The user can explicitly specify the value
    39  //     	// force a fatal error if the desired success code is not reached.
    40  //     	success: bool
    41  //     }
    42  //
    43  package exec