Scala CMD
0.0.4
API
Generated with
Scala CMD/works.scala.cmd/CmdApp

CmdApp

works.scala.cmd.CmdApp
trait CmdApp extends Cmd with IOApp

A trait for your single-command CLI to extend.

Attributes

Source:
CmdApp.scala
Graph
Supertypes
trait IOApp
trait Cmd
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Concrete methods

final override def run(args: List[String]): IO[ExitCode]

The entry point for your application. Will be called by the runtime when the process is started. If the underlying runtime supports it, any arguments passed to the process will be made available in the args parameter. The numeric value within the resulting ExitCode will be used as the exit code when the process terminates unless terminated exceptionally or by interrupt.

The entry point for your application. Will be called by the runtime when the process is started. If the underlying runtime supports it, any arguments passed to the process will be made available in the args parameter. The numeric value within the resulting ExitCode will be used as the exit code when the process terminates unless terminated exceptionally or by interrupt.

Attributes

args

The arguments passed to the process, if supported by the underlying runtime. For example, java com.company.MyApp --foo --bar baz or node com-mycompany-fastopt.js --foo --bar baz would each result in List("--foo", "--bar", "baz").

See also:

IOApp.Simple!.run:cats\.effect\.IO[Unit]*

Definition Classes
IOApp
Source:
CmdApp.scala

Inherited methods

def args: Seq[Arg[_]]

The Args to parse for this app.

The Args to parse for this app.

Attributes

Inherited from:
Cmd
Source:
Cmd.scala
def command(args: List[String]): Unit

The main logic of your app

The main logic of your app

Attributes

Inherited from:
Cmd
Source:
Cmd.scala
def flags: Seq[Flag[_]]

The Flags to parse for this app.

The Flags to parse for this app.

Attributes

Inherited from:
Cmd
Source:
Cmd.scala
final def io(args: List[String]): IO[ExitCode]

Attributes

Inherited from:
Cmd
Source:
Cmd.scala
final def main(args: Array[String]): Unit

Attributes

Inherited from:
IOApp
Source:
IOApp.scala

Concrete fields

override val description: String

A short description of what this command does.

A short description of what this command does.

Attributes

Source:
CmdApp.scala
override val name: String

The name of the command. Used to run if part of a MultiCmdApp

The name of the command. Used to run if part of a MultiCmdApp

Attributes

Source:
CmdApp.scala
Generated with