Command
API
Generated with
Command/sbt

sbt

package sbt

Members list

Packages

package sbt.internal

Type members

Classlikes

final case class ApplicationID(groupID: String, name: String, version: String, mainClass: String, components: Seq[String], crossVersionedValue: CrossValue, extra: Seq[File]) extends ApplicationID

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait ApplicationID
class Object
trait Matchable
class Any
Show all
object ApplicationID

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object BasicCommandStrings

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object BasicCommands

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object BasicKeys

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
BasicKeys.type
sealed trait Command

An operation that can be executed from the sbt console.

An operation that can be executed from the sbt console.

The operation takes a State as a parameter and returns a State. This means that a command can look at or modify other sbt settings, for example. Typically you would resort to a command when you need to do something that's impossible in a regular task.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object Command

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Command.type
trait CommandDefinitions extends State => State

Attributes

Supertypes
trait State => State
class Object
trait Matchable
class Any
final class CommandSource extends Serializable

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any
object CommandSource

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
object CommandUtil

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
sealed abstract class ConnectionType extends Serializable

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any
Known subtypes
object Local.type
object Tcp.type
object ConnectionType

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
final class Exec extends Serializable

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any
object Exec

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
Exec.type
final case class Exit(code: Int) extends Exit

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Exit
trait MainResult
class Object
trait Matchable
class Any
Show all
trait Help

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object Help

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Help.type
object Highlight

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Highlight.type
trait Identity

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class State
final case class Reboot(scalaVersion: String, argsList: Seq[String], app: ApplicationID, baseDirectory: File) extends Reboot

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Reboot
trait MainResult
class Object
trait Matchable
class Any
Show all
sealed abstract class ServerAuthentication extends Serializable

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any
Known subtypes
object Token.type
object ServerAuthentication

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class State(configuration: AppConfiguration, definedCommands: Seq[Command], exitHooks: Set[ExitHook], onFailure: Option[Exec], remainingCommands: List[Exec], history: History, attributes: AttributeMap, globalLogging: GlobalLogging, currentCommand: Option[Exec], next: Next) extends Identity

Data structure representing all command execution information.

Data structure representing all command execution information.

Value parameters

attributes

custom command state. It is important to clean up attributes when no longer needed to avoid memory leaks and class loader leaks.

configuration

provides access to the launcher environment, including the application configuration, Scala versions, jvm/filesystem wide locking, and the launcher itself

definedCommands

the list of command definitions that evaluate command strings. These may be modified to change the available commands.

exitHooks

code to run before sbt exits, usually to ensure resources are cleaned up.

history

tracks the recently executed commands

next

the next action for the command processor to take. This may be to continue with the next command, adjust global logging, or exit.

onFailure

the command to execute when another command fails. onFailure is cleared before the failure handling command is executed.

remainingCommands

the sequence of commands to execute. This sequence may be modified to change the commands to be executed. Typically, the :: and ::: methods are used to prepend new commands to run.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Identity
class Object
trait Matchable
class Any
Show all
object State

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
State.type
trait StateOps

Convenience methods for State transformations and operations.

Convenience methods for State transformations and operations.

Attributes

Supertypes
class Any
Known subtypes
class StateOpsImpl
case class TemplateResolverInfo(module: ModuleID, implementationClass: String)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Watched

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Watched.type

Deprecated classlikes

trait Watched

Attributes

Companion
object
Deprecated
true
Supertypes
class Object
trait Matchable
class Any
Generated with