Packages

object Command extends Command

A utility to allow for processing the outout from an external process in a streaming manner. When Command.run is called, a CommandOutput is returned, which provides a com.twitter.io.Reader interface to both the stdout and stderr of the external process.

Example usage:

// Run a shell command and log the output as it shows up, and then discards the output

val commandOutput: CommandOutput = Command.run(Seq("./slow-shell-command.sh")
val logged: Reader[Unit] = commandOutput.stdout.map {
 case Buf.Utf8(str) => info(s"stdout: $str")
}
Await.result(Reader.readAllLines(logged).onFailure {
 case NonZeroReturnCode(_, code, stderr) =>
   val errors = stderr.map {
     case Buf.Utf8(str) => str
   }
   error(s"failure: $code")
   errors.foreach(errLine => error(s"stderr: $errLine")
})
Linear Supertypes
Command, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Command
  2. Command
  3. AnyRef
  4. 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. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. def run(cmd: Seq[String], workingDirectory: Option[File] = None, extraEnv: Map[String, String] = Map.empty): CommandOutput

    Runs a shell command and returns a CommandOutput.

    Runs a shell command and returns a CommandOutput. See the CommandOutput scaladoc for more details on the behavior of fields.

    cmd

    The shell command to run

    workingDirectory

    An optional directory from which the command should be run

    extraEnv

    A map of extra environment variables to set for the command to be run

    returns

    A CommandOutput with stdout & stderr from the command

    Definition Classes
    Command
  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Command

Inherited from AnyRef

Inherited from Any

Ungrouped