Scala 3
3.9.0-RC1-bin-20260423-5d6b9a4-NIGHTLY
LearnInstallPlaygroundFind A LibraryCommunityBlog
LearnInstallPlaygroundFind A LibraryCommunityBlog
DocsAPI
Generated with
Copyright (c) 2002-2026, LAMP/EPFL
Copyright (c) 2002-2026, LAMP/EPFL
Scala 3/scala/scala.sys/scala.sys.process/Process

Process

scala.sys.process.Process
See theProcess companion trait
object Process extends ProcessCreation

Methods for constructing simple commands that can then be combined.

Attributes

Companion
trait
Source
Process.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Process.type

Members list

Value members

Inherited methods

def apply(name: String, exitValue: => Int): ProcessBuilder

Creates a scala.sys.process.ProcessBuilder from a String name and a Boolean. This can be used to force an exit value, with the name being used for toString.

Creates a scala.sys.process.ProcessBuilder from a String name and a Boolean. This can be used to force an exit value, with the name being used for toString.

Value parameters

exitValue

the exit code that this process will return (by-name, evaluated on each access)

name

the name used for the toString representation of this process

Attributes

Returns

a ProcessBuilder that immediately exits with the given exit code

Inherited from:
ProcessCreation
Source
Process.scala
def apply(value: Boolean): ProcessBuilder

Creates a scala.sys.process.ProcessBuilder from a Boolean. This can be to force an exit value.

Creates a scala.sys.process.ProcessBuilder from a Boolean. This can be to force an exit value.

Value parameters

value

if true, the process exits with code 0; if false, with code 1

Attributes

Returns

a ProcessBuilder that immediately exits with the corresponding exit code

Inherited from:
ProcessCreation
Source
Process.scala
def apply(url: URL): URLBuilder

Creates a scala.sys.process.ProcessBuilder from a java.net.URL. This ProcessBuilder can then be used as a Source, so that one can pipe things from it.

Creates a scala.sys.process.ProcessBuilder from a java.net.URL. This ProcessBuilder can then be used as a Source, so that one can pipe things from it.

Value parameters

url

the URL to use as a source for the process

Attributes

Returns

a URLBuilder wrapping the given URL

Inherited from:
ProcessCreation
Source
Process.scala
def apply(file: File): FileBuilder

Creates a scala.sys.process.ProcessBuilder from a java.io.File. This ProcessBuilder can then be used as a Source or a Sink, so one can pipe things from and to it.

Creates a scala.sys.process.ProcessBuilder from a java.io.File. This ProcessBuilder can then be used as a Source or a Sink, so one can pipe things from and to it.

Value parameters

file

the file to use as a source or sink for the process

Attributes

Returns

a FileBuilder wrapping the given file

Inherited from:
ProcessCreation
Source
Process.scala
def apply(builder: JProcessBuilder): ProcessBuilder

Creates a scala.sys.process.ProcessBuilder from a java.lang.ProcessBuilder.

Creates a scala.sys.process.ProcessBuilder from a java.lang.ProcessBuilder.

Value parameters

builder

the java.lang.ProcessBuilder to wrap

Attributes

Returns

a new ProcessBuilder wrapping the given Java process builder

Example 
apply((new java.lang.ProcessBuilder("ls", "-l")) directory new java.io.File(System.getProperty("user.home")))
Inherited from:
ProcessCreation
Source
Process.scala
def apply(command: Seq[String], cwd: Option[File], extraEnv: (String, String)*): ProcessBuilder

Creates a scala.sys.process.ProcessBuilder with working dir optionally set to File and extra environment variables.

Creates a scala.sys.process.ProcessBuilder with working dir optionally set to File and extra environment variables.

Value parameters

command

a sequence where the first element is the executable and the rest are arguments

cwd

an optional working directory for the process

extraEnv

environment variable name-value pairs to add to the process environment

Attributes

Returns

a new ProcessBuilder for the given command

Example 
apply("java" :: javaArgs, params.get("cwd"), "CLASSPATH" -> "library.jar")
Inherited from:
ProcessCreation
Source
Process.scala
def apply(command: String, cwd: Option[File], extraEnv: (String, String)*): ProcessBuilder

Creates a scala.sys.process.ProcessBuilder with working dir optionally set to File and extra environment variables.

Creates a scala.sys.process.ProcessBuilder with working dir optionally set to File and extra environment variables.

Value parameters

command

the command string, including parameters separated by spaces

cwd

an optional working directory for the process

extraEnv

environment variable name-value pairs to add to the process environment

Attributes

Returns

a new ProcessBuilder for the given command

Example 
apply("java", params.get("cwd"), "CLASSPATH" -> "library.jar")
Inherited from:
ProcessCreation
Source
Process.scala
def apply(command: Seq[String], cwd: File, extraEnv: (String, String)*): ProcessBuilder

Creates a scala.sys.process.ProcessBuilder with working dir set to File and extra environment variables.

Creates a scala.sys.process.ProcessBuilder with working dir set to File and extra environment variables.

Value parameters

command

a sequence where the first element is the executable and the rest are arguments

cwd

the working directory for the process

extraEnv

environment variable name-value pairs to add to the process environment

Attributes

Returns

a new ProcessBuilder for the given command with the specified working directory

Example 
apply("java" :: javaArgs, new java.io.File("/opt/app"), "CLASSPATH" -> "library.jar")
Inherited from:
ProcessCreation
Source
Process.scala
def apply(command: String, cwd: File, extraEnv: (String, String)*): ProcessBuilder

Creates a scala.sys.process.ProcessBuilder with working dir set to File and extra environment variables.

Creates a scala.sys.process.ProcessBuilder with working dir set to File and extra environment variables.

Value parameters

command

the command string, including parameters separated by spaces

cwd

the working directory for the process

extraEnv

environment variable name-value pairs to add to the process environment

Attributes

Returns

a new ProcessBuilder for the given command with the specified working directory

Example 
apply("java", new java.io.File("/opt/app"), "CLASSPATH" -> "library.jar")
Inherited from:
ProcessCreation
Source
Process.scala
def apply(command: String, arguments: Seq[String]): ProcessBuilder

Creates a scala.sys.process.ProcessBuilder from a command represented by a String, and a sequence of String representing the arguments.

Creates a scala.sys.process.ProcessBuilder from a command represented by a String, and a sequence of String representing the arguments.

Value parameters

arguments

the arguments to pass to the command

command

the executable to run

Attributes

Returns

a new ProcessBuilder for the given command and arguments

Example 
apply("cat", files)
Inherited from:
ProcessCreation
Source
Process.scala
def apply(command: Seq[String]): ProcessBuilder

Creates a scala.sys.process.ProcessBuilder from a sequence of String, where the head is the command and each element of the tail is a parameter.

Creates a scala.sys.process.ProcessBuilder from a sequence of String, where the head is the command and each element of the tail is a parameter.

Value parameters

command

a sequence where the first element is the executable and the rest are arguments

Attributes

Returns

a new ProcessBuilder for the given command

Example 
apply("cat" :: files)
Inherited from:
ProcessCreation
Source
Process.scala
def apply(command: String): ProcessBuilder

Creates a scala.sys.process.ProcessBuilder from a String, including the parameters.

Creates a scala.sys.process.ProcessBuilder from a String, including the parameters.

Value parameters

command

the command string, including parameters separated by spaces

Attributes

Returns

a new ProcessBuilder for the given command

Example 
apply("cat file.txt")
Inherited from:
ProcessCreation
Source
Process.scala
def applySeq[T](builders: Seq[T])(implicit convert: T => Source): Seq[Source]

Creates a sequence of scala.sys.process.ProcessBuilder.Source from a sequence of something else for which there's an implicit conversion to Source.

Creates a sequence of scala.sys.process.ProcessBuilder.Source from a sequence of something else for which there's an implicit conversion to Source.

Type parameters

T

the type of the elements to be converted to Source

Value parameters

builders

the sequence of elements to convert

convert

the implicit conversion from T to Source

Attributes

Returns

a sequence of Source instances converted from the input elements

Inherited from:
ProcessCreation
Source
Process.scala
def cat(files: Seq[Source]): ProcessBuilder

Creates a scala.sys.process.ProcessBuilder from a non-empty sequence of scala.sys.process.ProcessBuilder.Source, which can then be piped to something else.

Creates a scala.sys.process.ProcessBuilder from a non-empty sequence of scala.sys.process.ProcessBuilder.Source, which can then be piped to something else.

This will concatenate the output of all sources.

Value parameters

files

the non-empty sequence of sources to concatenate; throws IllegalArgumentException if empty

Attributes

Returns

a ProcessBuilder whose output is the concatenation of all sources

Inherited from:
ProcessCreation
Source
Process.scala
def cat(file: Source, files: Source*): ProcessBuilder

Creates a scala.sys.process.ProcessBuilder from one or more scala.sys.process.ProcessBuilder.Source, which can then be piped to something else.

Creates a scala.sys.process.ProcessBuilder from one or more scala.sys.process.ProcessBuilder.Source, which can then be piped to something else.

This will concatenate the output of all sources. For example:

import scala.sys.process._
import scala.sys.process.Process.cat
import java.net.URL
import java.io.File

val spde = new URL("http://technically.us/spde.html")
val dispatch = new URL("https://dispatchhttp.org/Dispatch.html")
val build = new File("project/build.properties")
cat(spde, dispatch, build) #| "grep -i scala" !

Value parameters

file

the first Source to concatenate

files

additional Source values to concatenate after the first

Attributes

Returns

a ProcessBuilder whose output is the concatenation of all sources

Inherited from:
ProcessCreation
Source
Process.scala
Generated with
Copyright (c) 2002-2026, LAMP/EPFL
Copyright (c) 2002-2026, LAMP/EPFL