1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
|
// Copyright 2018 The CUE Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package exec
// Run executes a program with the given arguments.
Run: {
$id: _id
_id: *"tool/exec.Run" | "exec" // exec for backwards compatibility
// cmd is a non-empty list holding the program name to run
// and the arguments to be passed to it.
//
// Simple commands can use a string, which is split by white space characters.
// If any arguments include white space, or for clarity, use the list form.
cmd: string | [string, ...string]
// dir specifies the working directory of the command.
// The default is the current working directory.
dir?: string
// env defines the environment variables to use for this system.
// If the value is a list, the entries mus be of the form key=value,
// where the last value takes precendence in the case of multiple
// occurrances of the same key.
env: {[string]: string} | [...=~"="]
// stdout captures the output from stdout if it is of type bytes or string.
// The default value of null indicates it is redirected to the stdout of the
// current process.
stdout: *null | string | bytes
// stderr is like stdout, but for errors.
stderr: *null | string | bytes
// stdin specifies the input for the process. If stdin is null, the stdin
// of the current process is redirected to this command (the default).
// If it is of typ bytes or string, that input will be used instead.
stdin: *null | string | bytes
// success is set to true when the process terminates with a zero exit
// code or false otherwise. The user can explicitly specify the value
// force a fatal error if the desired success code is not reached.
success: bool
// mustSucceed indicates whether a command must succeed, in which case success==false results in a fatal error.
// This option is enabled by default, but may be disabled to control what is done when a command execution fails.
mustSucceed: bool | *true
}
|