ReplAPI

Abstract Value Members

implicit abstract def Relativizer[T](p: T)(implicit b: Path, f: (T) ⇒ RelPath): Path

Allows you to use relative paths (and anything convertible to a relative path) as absolute paths when working in the REPL.
Allows you to use relative paths (and anything convertible to a relative path) as absolute paths when working in the REPL. Note that this isn't available when using Ammonite-Ops in a standalone project! In such cases, it's good practice to convert paths from relative to absolute explicitly.

Definition Classes
OpsAPI
abstract val cd: Op1[Path, Path]

Change the working directory wd; if the provided path is relative it gets appended on to the current wd, if it's absolute it replaces.
Change the working directory wd; if the provided path is relative it gets appended on to the current wd, if it's absolute it replaces.

Definition Classes
OpsAPI
abstract val colors: Ref[Colors]

The colors that will be used to render the Ammonite REPL in the terminal
abstract def compiler: Global

Access the compiler to do crazy things if you really want to!
abstract val frontEnd: Ref[FrontEnd]

The front-end REPL used to take user input.
The front-end REPL used to take user input. Modifiable!
abstract def fullHistory: History

History of commands that have been entered into the shell, including previous sessions
abstract def height: Int

Current height of the terminal
abstract def help: String

Display help text if you don't know how to use the REPL
abstract def history: History

History of commands that have been entered into the shell during the current session
abstract def imports: String

Show all the imports that are used to execute commands going forward
abstract def load: Load

Tools related to loading external scripts and code into the REPL
abstract def newCompiler(): Unit

Throw away the current scala.
Throw away the current scala.tools.nsc.Global and get a new one
implicit abstract val pprintConfig: Ref[Config]

Controls how things are pretty-printed in the REPL.
Controls how things are pretty-printed in the REPL. Feel free to shadow this with your own definition to change how things look
abstract val prompt: Ref[String]

Read/writable prompt for the shell.
Read/writable prompt for the shell. Use this to change the REPL prompt at any time!
abstract def show[T](t: T, width: Integer = 0, height: Integer = null, indent: Integer = null, colors: pprint.Colors = null)(implicit arg0: PPrint[T], cfg: Config = Config.Defaults.PPrintConfig): Unit
abstract def show[T](implicit arg0: PPrint[T], cfg: Config): (T) ⇒ Unit

Lets you configure the pretty-printing of a value.
Lets you configure the pretty-printing of a value. By default, it simply disables truncation and prints the entire thing, but you can set other parameters as well if you want.
abstract def typeOf[T](t: ⇒ T)(implicit arg0: scala.reflect.api.JavaUniverse.WeakTypeTag[T]): scala.reflect.api.JavaUniverse.Type

Get the Type object representing the type of t.
Get the Type object representing the type of t. Useful for finding what its methods are and what you can do with it
abstract def typeOf[T](implicit arg0: scala.reflect.api.JavaUniverse.WeakTypeTag[T]): scala.reflect.api.JavaUniverse.Type

Get the Type object of T.
Get the Type object of T. Useful for finding what its methods are and what you can do with it
implicit abstract def wd: Path

The current working directory of the shell, that will get picked up by any Relativizer below, and can be modified using cd
The current working directory of the shell, that will get picked up by any Relativizer below, and can be modified using cd

Definition Classes
OpsAPI
abstract def width: Int

Current width of the terminal

Concrete 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( ... )
implicit def derefPPrint(implicit t: Ref[Config]): Config
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def exit: Nothing

Exit the Ammonite REPL.
Exit the Ammonite REPL. You can also use Ctrl-D to exit
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
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
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
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( ... )

trait ReplAPI extends OpsAPI

Abstract Value Members

implicit abstract def Relativizer[T](p: T)(implicit b: Path, f: (T) ⇒ RelPath): Path

abstract val cd: Op1[Path, Path]

abstract val colors: Ref[Colors]

abstract def compiler: Global

abstract val frontEnd: Ref[FrontEnd]

abstract def fullHistory: History

abstract def height: Int

abstract def help: String

abstract def history: History

abstract def imports: String

abstract def load: Load

abstract def newCompiler(): Unit

implicit abstract val pprintConfig: Ref[Config]

abstract val prompt: Ref[String]

abstract def show[T](t: T, width: Integer = 0, height: Integer = null, indent: Integer = null, colors: pprint.Colors = null)(implicit arg0: PPrint[T], cfg: Config = Config.Defaults.PPrintConfig): Unit

abstract def show[T](implicit arg0: PPrint[T], cfg: Config): (T) ⇒ Unit

abstract def typeOf[T](t: ⇒ T)(implicit arg0: scala.reflect.api.JavaUniverse.WeakTypeTag[T]): scala.reflect.api.JavaUniverse.Type

abstract def typeOf[T](implicit arg0: scala.reflect.api.JavaUniverse.WeakTypeTag[T]): scala.reflect.api.JavaUniverse.Type

implicit abstract def wd: Path

abstract def width: Int

Concrete 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

implicit def derefPPrint(implicit t: Ref[Config]): Config

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def exit: Nothing

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from OpsAPI

Inherited from AnyRef

Inherited from Any

Ungrouped