Packages

sealed trait Command extends AnyRef

Linear Supertypes
AnyRef, Any
Known Subclasses
Piped, Standard
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Command
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def <<(input: String): Command

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

  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. def >(redirectTo: File): Command

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

  6. def >>(redirectTo: File): Command

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

  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  9. def env(env: Map[String, String]): Command

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

  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  12. def exitCode: ZIO[Any, CommandError, ExitCode]

    Runs the command returning only the exit code.

  13. def flatten: NonEmptyChunk[Standard]

    Flatten this command to a non-empty chunk of standard commands.

    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.

  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def inheritIO: Command

    Inherit standard input, standard output, and standard error.

  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. def lines(charset: Charset): ZIO[Any, CommandError, Chunk[String]]

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

  19. def lines: ZIO[Any, CommandError, Chunk[String]]

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

  20. def linesStream: ZStream[Any, CommandError, String]

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

  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. def pipe(into: Command): Command

    A named alias for |

  25. def redirectErrorStream(redirectErrorStream: Boolean): Command

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

  26. def run: ZIO[Any, CommandError, Process]

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

  27. def stderr(stderr: ProcessOutput): Command

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

  28. def stdin(stdin: ProcessInput): Command

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

  29. def stdout(stdout: ProcessOutput): Command

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

  30. def stream: ZStream[Any, CommandError, Byte]

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

  31. def string(charset: Charset): ZIO[Any, CommandError, String]

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

  32. def string: ZIO[Any, CommandError, String]

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

  33. def successfulExitCode: ZIO[Any, CommandError, ExitCode]

    Runs the command returning only the exit code if zero.

  34. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  35. def toString(): String
    Definition Classes
    AnyRef → Any
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  38. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  39. def workingDirectory(workingDirectory: File): Command

    Set the working directory that will be used when this command will be run.

    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.

  40. def |(into: Command): Command

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

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped