Command

sealed trait Command
Companion
object
class Object
trait Matchable
class Any
class Standard
class Piped

Value members

Concrete methods

def <<(input: String): Command

Feed a string to standard input (default encoding of UTF-8).

Feed a string to standard input (default encoding of UTF-8).

def >(redirectTo: File): Command

Redirect standard output to a file, overwriting any existing content.

Redirect standard output to a file, overwriting any existing content.

def >>(redirectTo: File): Command

Redirect standard output to a file, appending content to the file if it already exists.

Redirect standard output to a file, appending content to the file if it already exists.

def env(env: Map[String, String]): Command

Specify the environment variables that will be used when running this command.

Specify the environment variables that will be used when running this command.

def exitCode: ZIO[Blocking, CommandError, ExitCode]

Runs the command returning only the exit code.

Runs the command returning only the exit code.

def flatten: NonEmptyChunk[Standard]

Flatten this command to a non-empty chunk of standard commands. For the standard case, this simply returns a 1 element chunk. For the piped case, all the commands in the pipe will be extracted out into a chunk from left to right.

Flatten this command to a non-empty chunk of standard commands. For the standard case, this simply returns a 1 element chunk. For the piped case, all the commands in the pipe will be extracted out into a chunk from left to right.

Inherit standard input, standard output, and standard error.

Inherit standard input, standard output, and standard error.

def lines: ZIO[Blocking, CommandError, Chunk[String]]

Runs the command returning the output as a list of lines (default encoding of UTF-8).

Runs the command returning the output as a list of lines (default encoding of UTF-8).

def lines(charset: Charset): ZIO[Blocking, CommandError, Chunk[String]]

Runs the command returning the output as a list of lines with the specified encoding.

Runs the command returning the output as a list of lines with the specified encoding.

def linesStream: ZStream[Blocking, CommandError, String]

Runs the command returning the output as a stream of lines (default encoding of UTF-8).

Runs the command returning the output as a stream of lines (default encoding of UTF-8).

def pipe(into: Command): Command

A named alias for |

A named alias for |

def redirectErrorStream(redirectErrorStream: Boolean): Command

Redirect the error stream to be merged with the standard output stream.

Redirect the error stream to be merged with the standard output stream.

def run: ZIO[Blocking, CommandError, Process]

Start running the command returning a handle to the running process.

Start running the command returning a handle to the running process.

Specify what to do with the standard error of this command.

Specify what to do with the standard error of this command.

def stdin(stdin: ProcessInput): Command

Specify what to do with the standard input of this command.

Specify what to do with the standard input of this command.

Specify what to do with the standard output of this command.

Specify what to do with the standard output of this command.

def stream: ZStream[Blocking, CommandError, Byte]

Runs the command returning the output as a chunked stream of bytes.

Runs the command returning the output as a chunked stream of bytes.

def string: ZIO[Blocking, CommandError, String]

Runs the command returning the entire output as a string (default encoding of UTF-8).

Runs the command returning the entire output as a string (default encoding of UTF-8).

def string(charset: Charset): ZIO[Blocking, CommandError, String]

Runs the command returning the entire output as a string with the specified encoding.

Runs the command returning the entire output as a string with the specified encoding.

def successfulExitCode: ZIO[Blocking, CommandError, ExitCode]

Runs the command returning only the exit code if zero.

Runs the command returning only the exit code if zero.

def workingDirectory(workingDirectory: File): Command

Set the working directory that will be used when this command will be run. For the piped case, each piped command's working directory will also be set.

Set the working directory that will be used when this command will be run. For the piped case, each piped command's working directory will also be set.

def |(into: Command): Command

Pipe the output of this command into the input of the specified command.

Pipe the output of this command into the input of the specified command.