Skip to main content

Run

The run command runs your Scala code:

Hello.scala
object Hello {
  def main(args: Array[String]): Unit =
    println("Hello")
}
scala-cli run Hello.scala
Hello

This is the default command, so you don’t have to specify it explicitly:

scala-cli Hello.scala
Hello

Passing arguments​

You can pass arguments to the application or script you're launching after --:

app.sc
println(args.mkString("App called with arguments: ", ", ", ""))
scala-cli app.sc -- first-arg second-arg
App called with arguments: first-arg, second-arg

Main class​

If your application has multiple main classes, the --main-class option lets you explicitly specify the main class you want to run:

hi.sc
println("Hi")
scala-cli Hello.scala hi.sc --main-class hi_sc

Custom JVM​

--jvm lets you run your application with a custom JVM:

scala-cli Hello.scala --jvm adopt:14

You can also specify custom JVM with the using directive //> using jvm:

//> using jvm adopt:14

JVMs are managed by coursier, and are read from the coursier JVM index. (New JVM versions are automatically checked daily, and updates for those are - manually - merged swiftly.)

JVM options​

--java-opt lets you add java options which will be passed when running an application:

scala-cli Hello.scala --java-opt -Xmx1g --java-opt -Dfoo=bar

You can also add java options with the using directive //> using javaOpt:

//> using javaOpt -Xmx1g -Dfoo=bar

Additionally, java properties can be passed to Scala CLI without --java-prop:

scala-cli Hello.scala -Dfoo=bar

JAR​

Scala CLI lets you run JAR files just like any other input.

scala-cli Hello.jar
Hello World

When you provide a JAR file as input to Scala CLI, it will be added to the classPath.

Define source files in using directives​

You can also add source files with the using directive //> using file:

Main.scala
//> using file Utils.scala

object Main extends App {
  println(Utils.message)
}
Utils.scala
object Utils {
  val message = "Hello World"
}

Scala CLI takes it into account and compiles Utils.scala.

scala-cli Main.scala
Hello World

It is also possible to pass multiple paths to source files in a single using directive:

Multiple.scala
//> using files Utils.scala Main.scala
scala-cli run Multiple.scala

Note that the //> using file using directive only supports .java, .scala, .sc files or a directory.

Watch mode​

--watch makes Scala CLI watch your code for changes, and re-runs it upon any change or when the ENTER key is passed from the command line:

scala-cli run Hello.scala  --watch
Hello
Program exited with return code 0.
Watching sources, press Ctrl+C to exit, or press Enter to re-run.
Compiling project (Scala 3.2.2, JVM)
Compiled project (Scala 3.2.2, JVM)
Hello World
Program exited with return code 0.
Watching sources, press Ctrl+C to exit, or press Enter to re-run.

Watch mode (restart)​

The --restart option works very similarly to --watch, but instead of waking the sleeping thread, it kills the process and restarts the app whenever sources change or the ENTER key is passed from the command line.

scala-cli run Hello.scala --restart
Watching sources while your program is running.
Hello
Program exited with return code 0.
Watching sources while your program is running.
Compiling project (Scala 3.2.2, JVM)
Compiled project (Scala 3.2.2, JVM)
Hello World
Program exited with return code 0.
Watching sources while your program is running.

Scala.js​

Scala.js applications can also be compiled and run with the --js option. Note that this requires node to be installed on your system:

scala-cli Hello.scala --js

It is also possible to achieve it using --platform option:

scala-cli Hello.scala --platform js

See our dedicated Scala.js guide for more information.

Scala Native​

Scala Native applications can be compiled and run with the --native option. Note that the Scala Native requirements need to be installed for this to work:

scala-cli Hello.scala --native -S 2.13.6

It is also possible to achieve it using --platform option:

scala-cli Hello.scala --platform native

We have a dedicated Scala Native guide as well.

Platform​

The --platform option can be used to choose the platform, which should be used to compile and run application. Available platforms are:

  • JVM (jvm)
  • Scala.js (scala.js | scala-js | scalajs | js)
  • Scala Native (scala-native | scalanative | native)

Passing the --platform along with --js or --native is not recommended. If two different types of platform are passed, Scala CLI throws an error.

Scala Scripts​

Scala CLI can also compile and run Scala scripts:

HelloScript.sc
#!/ usr / bin / env -S scala -cli shebang

println("Hello world from scala script")
scala-cli run HelloScript.sc
Hello world from scala script

Our scripts guide provides many more details.

Scala CLI from docker​

Scala applications can also be compiled and run using a docker image with Scala CLI, without needing to install Scala CLI manually:

docker run virtuslab/scala-cli:latest version
HelloWorld.scala
object HelloWorld extends App {
  println("Hello world")
}
docker run  -v $(pwd)/HelloWorld.scala:/HelloWorld.scala virtuslab/scala-cli /HelloWorld.scala
Hello world

Debugging​

It is possible to debug code by passing --debug flag.

Additional debug options:

  • --debug-mode (attach by default)
  • --debug-port (5005 by default)

Available debug modes:

  • Attach (attach | att | a)
  • Listen (listen | lis | l)

Example debugging with scala-cli:

scala-cli Foo.scala --debug --debug-mode l --debug-port 5006

Inject code as JAR file in class path​

If your application inspects its class path, and requires only JAR files in it, use --as-jar to put the Scala CLI project in the class path as a JAR file rather than as a directory:

scala-cli Foo.scala --as-jar