Main

Contains the various entry points to the Ammonite REPL.

Configuration of the basic REPL is done by passing in arguments when constructing the Main instance, and the various entrypoints such as run runScript and so on are methods on that instance.

It is more or less equivalent to the ammonite.repl.Repl object itself, and has a similar set of parameters, but does not have any of the ammonite.repl.Repl's implementation-related code and provides a more convenient set of entry-points that a user can call.

Note that the instantiateRepl function generates a new Repl every time it is called!

predef: Any additional code you want to run before the REPL session starts. Can contain multiple blocks separated by @s
defaultPredef: Do you want to include the "standard" predef imports provided by Ammonite? These include tools like time, grep, the | or |? pipes from ammonite-ops, and other helpers. Can be disabled to give a clean namespace for you to fill using your own predef.
storageBackend: Where will all of Ammonite's persistent data get stored? Things like any predef.sc file, compilation/ivy caches, etc.. Defaults include Storage.Folder and Storage.InMemory, though you can create your own.
wd: The working directory of the REPL; when it load scripts, where the scripts will be considered relative to when assigning them packages
inputStream: Where input to the Repl is coming from, typically System.in, but it could come from somewhere else e.g. across the network in the case of the SshdRepl
outputStream: Primary output of code run using Ammonite
infoStream: Miscellaneous logging output when running Ammonite. This is typically stuff you want to see when running interactively, but not something you want to see when e.g. you forward a script's output to a file. This by default it goes to System.err
errorStream: Error output when things go bad, typically System.err

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new Main(predef: String = "", defaultPredef: Boolean = true, storageBackend: Storage = ..., wd: Path = ammonite.ops.`package`.pwd, welcomeBanner: Option[String] = ..., inputStream: InputStream = java.this.lang.System.in, outputStream: OutputStream = java.this.lang.System.out, infoStream: OutputStream = java.this.lang.System.err, errorStream: OutputStream = java.this.lang.System.err, verboseOutput: Boolean = true, remoteLogging: Boolean = true)

predef
Any additional code you want to run before the REPL session starts. Can contain multiple blocks separated by @s
defaultPredef
Do you want to include the "standard" predef imports provided by Ammonite? These include tools like time, grep, the | or |? pipes from ammonite-ops, and other helpers. Can be disabled to give a clean namespace for you to fill using your own predef.
storageBackend
Where will all of Ammonite's persistent data get stored? Things like any predef.sc file, compilation/ivy caches, etc.. Defaults include Storage.Folder and Storage.InMemory, though you can create your own.
wd
The working directory of the REPL; when it load scripts, where the scripts will be considered relative to when assigning them packages
inputStream
Where input to the Repl is coming from, typically System.in, but it could come from somewhere else e.g. across the network in the case of the SshdRepl
outputStream
Primary output of code run using Ammonite
infoStream
Miscellaneous logging output when running Ammonite. This is typically stuff you want to see when running interactively, but not something you want to see when e.g. you forward a script's output to a file. This by default it goes to System.err
errorStream
Error output when things go bad, typically System.err

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val defaultPredef: Boolean

Do you want to include the "standard" predef imports provided by Ammonite? These include tools like time, grep, the | or |? pipes from ammonite-ops, and other helpers.
Do you want to include the "standard" predef imports provided by Ammonite? These include tools like time, grep, the | or |? pipes from ammonite-ops, and other helpers. Can be disabled to give a clean namespace for you to fill using your own predef.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val errorStream: OutputStream

Error output when things go bad, typically System.
Error output when things go bad, typically System.err
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
val infoStream: OutputStream

Miscellaneous logging output when running Ammonite.
Miscellaneous logging output when running Ammonite. This is typically stuff you want to see when running interactively, but not something you want to see when e.g. you forward a script's output to a file. This by default it goes to System.err
val inputStream: InputStream

Where input to the Repl is coming from, typically System.
Where input to the Repl is coming from, typically System.in, but it could come from somewhere else e.g. across the network in the case of the SshdRepl
def instantiateInterpreter(replApi: Boolean): Interpreter
def instantiateRepl(replArgs: Seq[Bind[_]] = Nil, remoteLogger: Option[RemoteLogger]): Repl

Instantiates an ammonite.
Instantiates an ammonite.Repl using the configuration
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val outputStream: OutputStream

Primary output of code run using Ammonite
val predef: String

Any additional code you want to run before the REPL session starts.
Any additional code you want to run before the REPL session starts. Can contain multiple blocks separated by @s
val remoteLogging: Boolean
def run(replArgs: Bind[_]*): Any
def runCode(code: String, replApi: Boolean = false): Unit

Run a snippet of code
def runScript(path: Path, scriptArgs: Seq[(String, Option[String])], replApi: Boolean = false): Res[Any]

Run a Scala script file! takes the path to the file as well as an array of args and a map of keyword kwargs to pass to that file.
val storageBackend: Storage

Where will all of Ammonite's persistent data get stored? Things like any predef.sc file, compilation/ivy caches, etc.
Where will all of Ammonite's persistent data get stored? Things like any predef.sc file, compilation/ivy caches, etc.. Defaults include Storage.Folder and Storage.InMemory, though you can create your own.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val verboseOutput: Boolean
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
val wd: Path

The working directory of the REPL; when it load scripts, where the scripts will be considered relative to when assigning them packages
val welcomeBanner: Option[String]

Instance Constructors

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val defaultPredef: Boolean

final def eq(arg0: AnyRef): Boolean

val errorStream: OutputStream

def finalize(): Unit

final def getClass(): Class[_]

val infoStream: OutputStream

val inputStream: InputStream

def instantiateInterpreter(replApi: Boolean): Interpreter

def instantiateRepl(replArgs: Seq[Bind[_]] = Nil, remoteLogger: Option[RemoteLogger]): Repl

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val outputStream: OutputStream

val predef: String

val remoteLogging: Boolean

def run(replArgs: Bind[_]*): Any

def runCode(code: String, replApi: Boolean = false): Unit

def runScript(path: Path, scriptArgs: Seq[(String, Option[String])], replApi: Boolean = false): Res[Any]

val storageBackend: Storage

final def synchronized[T0](arg0: ⇒ T0): T0

val verboseOutput: Boolean

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

val wd: Path

val welcomeBanner: Option[String]

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped