Scala Runner specification

This document describes proposed specification for Scala runner based on Scala CLI documentation as requested per SIP-46

Commands and options are marked with MUST and SHOULD (in the RFC style) for ones applicable for Scala Runner. Options and commands mark as Implementation that are needed for smooth running of Scala CLI. We recommend for this options and commands to be supported by scala command (when based on Scala CLI) but not the part of the Scala Runner specification.``

The proposed Scala runner specification should contains also supported Using directives defined in the dedicated document]

Scalac options forwarding

All options that start with:

• -g
• -language
• -opt
• -P
• -target
• -V
• -W
• -X
• -Y

are assumed to be Scala compiler options and will be propagated to Scala Compiler. This applies to all commands that uses compiler directly or indirectly.

MUST have commands

compile command

MUST have for Scala Runner specification.

Compile Scala code

MUST have options

--dependency

Add dependencies

Aliases: --dep

--compiler-plugin

Add compiler plugin dependencies

Aliases: -P ,--plugin

--scala-version

Set the Scala version

Aliases: --scala ,-S

--scala-binary-version

Set the Scala binary version

Aliases: --scala-binary ,--scala-bin ,-B

--extra-jars

Add extra JARs and compiled classes to the class path

Aliases: --jar ,--jars ,--extra-jar ,--class ,--extra-class ,--classes ,--extra-classes ,-classpath ,-cp ,--classpath ,--class-path ,--extra-class-path

--resource-dirs

Add a resource directory

Aliases: --resource-dir

--compilation-output

Copy compilation results to output directory using either relative or absolute path

Aliases: --output-directory ,-d ,--destination ,--compile-output ,--compile-out

SHOULD have options

--js

Enable Scala.js. To show more options for Scala.js pass --help-js

--js-version

The Scala.js version

--js-mode

The Scala.js mode, either dev or release

--js-module-kind

The Scala.js module kind: commonjs/common, esmodule/es, nomodule/none

--js-check-ir

--js-emit-source-maps

Emit source maps

--js-source-maps-path

Set the destination path of source maps

--js-dom

Enable jsdom

--js-header

A header that will be added at the top of generated .js files

--js-es-version

The Scala.js ECMA Script version: es5_1, es2015, es2016, es2017, es2018, es2019, es2020, es2021

--native

Enable Scala Native. To show more options for Scala Native pass --help-native

--native-version

Set the Scala Native version

--native-mode

Set Scala Native compilation mode

--native-gc

Set the Scala Native garbage collector

--native-linking

Extra options passed to clang verbatim during linking

--native-compile

List of compile options

--embed-resources

Embed resources into the Scala Native binary (can be read with the Java resources API)

--repository

Add repositories

Aliases: --repo ,-r

--debug

Turn debugging on

--debug-port

Debug port (5005 by default)

--debug-mode

Debug mode (attach by default)

--java-home

Set the Java home directory

--jvm

Use a specific JVM, such as 14, adopt:11, or graalvm:21, or system

Aliases: -j

--javac-plugin

Javac plugin dependencies or files

--javac-option

Javac options

Aliases: --javac-opt

--script-snippet

Allows to execute a passed string as a Scala script

--execute-script

A synonym to --script-snippet, which defaults the sub-command to run when no sub-command is passed explicitly

Aliases: --execute-scala-script ,--execute-sc ,-e

--scala-snippet

Allows to execute a passed string as Scala code

--extra-compile-only-jars

Add extra JARs in the compilaion class path. Mainly using to run code in managed environments like Spark not to include certain depenencies on runtime ClassPath.

Aliases: --compile-only-jar ,--compile-only-jars ,--extra-compile-only-jar

--extra-source-jars

Add extra source JARs

Aliases: --source-jar ,--source-jars ,--extra-source-jar

--platform

Specify platform

--semantic-db

Generate SemanticDBs

--watch

Watch source files for changes

Aliases: -w

--restart

Run your application in background and automatically restart if sources have been changed

Aliases: --revolver

--test

Compile test scope

Implementantation specific options

--usage

Print usage and exit

--help

Print help message and exit

Aliases: -h ,-help

--help-full

Print help message, including hidden options, and exit

Aliases: --full-help

--verbose

Increase verbosity (can be specified multiple times)

Aliases: -v

--interactive

Interactive mode

Aliases: -i

--actions

Enable actionable diagnostics

--quiet

Decrease verbosity

Aliases: -q

--progress

Use progress bars

--js-allow-big-ints-for-longs

Primitive Longs may be compiled as primitive JavaScript bigints

--js-avoid-classes

Avoid class'es when using functions and prototypes has the same observable semantics.

--js-avoid-lets-and-consts

Avoid lets and consts when using vars has the same observable semantics.

--js-module-split-style

The Scala.js module split style: fewestmodules, smallestmodules, smallmodulesfor

--js-small-module-for-package

Create as many small modules as possible for the classes in the passed packages and their subpackages.

--js-linker-path

Path to the Scala.js linker

--js-cli-version

Scala.js CLI version to use for linking

--js-cli-java-arg

Scala.js CLI Java options

--js-cli-on-jvm

Whether to run the Scala.js CLI on the JVM or using a native executable

--native-clang

Path to the Clang command

--native-clangpp

Path to the Clang++ command

--native-linking-defaults

Use default linking settings

--native-compile-defaults

Use default compile options

--bloop-bsp-protocol

Protocol to use to open a BSP connection with Bloop

--bloop-bsp-socket

Socket file to use to open a BSP connection with Bloop

--bloop-host

Host the compilation server should bind to

--bloop-port

Port the compilation server should bind to (pass -1 to pick a random port)

--bloop-daemon-dir

Daemon directory of the Bloop daemon (directory with lock, pid, and socket files)

--bloop-version

If Bloop isn't already running, the version we should start

--bloop-bsp-timeout

Maximum duration to wait for the BSP connection to be opened

--bloop-bsp-check-period

Duration between checks of the BSP connection state

--bloop-startup-timeout

Maximum duration to wait for the compilation server to start up

--bloop-default-java-opts

Include default JVM options for Bloop

--bloop-java-opt

Pass java options to use by Bloop server

--bloop-global-options-file

Bloop global options file

--bloop-jvm

JVM to use to start Bloop (e.g. 'system|11', 'temurin:17', …)

--bloop-working-dir

Working directory for Bloop, if it needs to be started

--server

Enable / disable usage of Bloop compilation server. Bloop is used by default so use --server:false to disable it. Disabling compilation server allows to test compilation in more controlled mannter (no caching or incremental compiler) but has a detrimental effect of performance.

--home-directory

Override the path to user's home directory

Aliases: --home

--scalac-option

Add a scalac option. Note that options starting with -g, -language, -opt, -P, -target, -V, -W, -X, and -Y are assumed to be Scala compiler options and don't require to be passed after -O or --scalac-option.

Aliases: --scala-opt ,-O ,--scala-option

--jvm-index

JVM index URL

--jvm-index-os

Operating system to use when looking up in the JVM index

--jvm-index-arch

CPU architecture to use when looking up in the JVM index

--bsp-debug-port

Port for BSP debugging

--ttl

Specify a TTL for changing dependencies, such as snapshots

--cache

Set the coursier cache location

--coursier-validate-checksums

Enable checksum validation of artifacts downloaded by coursier

--workspace

Directory where .scala-build is written

--scalac-help

Show help for scalac. This is an alias for --scalac-option -help

Aliases: --help-scalac

--scalac-verbose

Turn verbosity on for scalac. This is an alias for --scalac-option -verbose

Aliases: --verbose-scalac

--execute-scala

A synonym to --scala-snippet, which defaults the sub-command to run when no sub-command is passed explicitly

--java-snippet

Allows to execute a passed string as Java code

--execute-java

A synonym to --scala-snippet, which defaults the sub-command to run when no sub-command is passed explicitly

--scala-library

--java

Do not add dependency to Scala Standard library. This is useful, when Scala CLI works with pure Java projects.

--runner

Should include Scala CLI runner on the runtime ClassPath. Runner is added by default for application running on JVM using standard Scala versions. Runner is used to make stack traces more readable in case of application failure.

--add-stubs

Add dependency for stubs needed to make $ivy and $dep imports to work.

--default-forbidden-directories

--forbid

--help-js

Show options for ScalaJS

--help-native

Show options for ScalaNative

--strict-bloop-json-check

---

doc command

MUST have for Scala Runner specification.

Generate Scaladoc documentation

MUST have options

--dependency

Add dependencies

Aliases: --dep

--compiler-plugin

Add compiler plugin dependencies

Aliases: -P ,--plugin

--scala-version

Set the Scala version

Aliases: --scala ,-S

--scala-binary-version

Set the Scala binary version

Aliases: --scala-binary ,--scala-bin ,-B

--extra-jars

Add extra JARs and compiled classes to the class path

Aliases: --jar ,--jars ,--extra-jar ,--class ,--extra-class ,--classes ,--extra-classes ,-classpath ,-cp ,--classpath ,--class-path ,--extra-class-path

--resource-dirs

Add a resource directory

Aliases: --resource-dir

--compilation-output

Copy compilation results to output directory using either relative or absolute path

Aliases: --output-directory ,-d ,--destination ,--compile-output ,--compile-out

--output

Set the destination path

Aliases: -o

--force

Overwrite the destination directory, if it exists

Aliases: -f

SHOULD have options

--js

Enable Scala.js. To show more options for Scala.js pass --help-js

--js-version

The Scala.js version

--js-mode

The Scala.js mode, either dev or release

--js-module-kind

The Scala.js module kind: commonjs/common, esmodule/es, nomodule/none

--js-check-ir

--js-emit-source-maps

Emit source maps

--js-source-maps-path

Set the destination path of source maps

--js-dom

Enable jsdom

--js-header

A header that will be added at the top of generated .js files

--js-es-version

The Scala.js ECMA Script version: es5_1, es2015, es2016, es2017, es2018, es2019, es2020, es2021

--native

Enable Scala Native. To show more options for Scala Native pass --help-native

--native-version

Set the Scala Native version

--native-mode

Set Scala Native compilation mode

--native-gc

Set the Scala Native garbage collector

--native-linking

Extra options passed to clang verbatim during linking

--native-compile

List of compile options

--embed-resources

Embed resources into the Scala Native binary (can be read with the Java resources API)

--repository

Add repositories

Aliases: --repo ,-r

--debug

Turn debugging on

--debug-port

Debug port (5005 by default)

--debug-mode

Debug mode (attach by default)

--java-home

Set the Java home directory

--jvm

Use a specific JVM, such as 14, adopt:11, or graalvm:21, or system

Aliases: -j

--javac-plugin

Javac plugin dependencies or files

--javac-option

Javac options

Aliases: --javac-opt

--script-snippet

Allows to execute a passed string as a Scala script

--execute-script

A synonym to --script-snippet, which defaults the sub-command to run when no sub-command is passed explicitly

Aliases: --execute-scala-script ,--execute-sc ,-e

--scala-snippet

Allows to execute a passed string as Scala code

--extra-compile-only-jars

Add extra JARs in the compilaion class path. Mainly using to run code in managed environments like Spark not to include certain depenencies on runtime ClassPath.

Aliases: --compile-only-jar ,--compile-only-jars ,--extra-compile-only-jar

--extra-source-jars

Add extra source JARs

Aliases: --source-jar ,--source-jars ,--extra-source-jar

--platform

Specify platform

--semantic-db

Generate SemanticDBs

--default-scaladoc-options

Control if scala CLI should use default options for scaladoc, true by default. Use --default-scaladoc-opts:false to not include default options.

Aliases: --default-scaladoc-opts

Implementantation specific options

--usage

Print usage and exit

--help

Print help message and exit

Aliases: -h ,-help

--help-full

Print help message, including hidden options, and exit

Aliases: --full-help

--verbose

Increase verbosity (can be specified multiple times)

Aliases: -v

--interactive

Interactive mode

Aliases: -i

--actions

Enable actionable diagnostics

--quiet

Decrease verbosity

Aliases: -q

--progress

Use progress bars

--js-allow-big-ints-for-longs

Primitive Longs may be compiled as primitive JavaScript bigints

--js-avoid-classes

Avoid class'es when using functions and prototypes has the same observable semantics.

--js-avoid-lets-and-consts

Avoid lets and consts when using vars has the same observable semantics.

--js-module-split-style

The Scala.js module split style: fewestmodules, smallestmodules, smallmodulesfor

--js-small-module-for-package

Create as many small modules as possible for the classes in the passed packages and their subpackages.

--js-linker-path

Path to the Scala.js linker

--js-cli-version

Scala.js CLI version to use for linking

--js-cli-java-arg

Scala.js CLI Java options

--js-cli-on-jvm

Whether to run the Scala.js CLI on the JVM or using a native executable

--native-clang

Path to the Clang command

--native-clangpp

Path to the Clang++ command

--native-linking-defaults

Use default linking settings

--native-compile-defaults

Use default compile options

--bloop-bsp-protocol

Protocol to use to open a BSP connection with Bloop

--bloop-bsp-socket

Socket file to use to open a BSP connection with Bloop

--bloop-host

Host the compilation server should bind to

--bloop-port

Port the compilation server should bind to (pass -1 to pick a random port)

--bloop-daemon-dir

Daemon directory of the Bloop daemon (directory with lock, pid, and socket files)

--bloop-version

If Bloop isn't already running, the version we should start

--bloop-bsp-timeout

Maximum duration to wait for the BSP connection to be opened

--bloop-bsp-check-period

Duration between checks of the BSP connection state

--bloop-startup-timeout

Maximum duration to wait for the compilation server to start up

--bloop-default-java-opts

Include default JVM options for Bloop

--bloop-java-opt

Pass java options to use by Bloop server

--bloop-global-options-file

Bloop global options file

--bloop-jvm

JVM to use to start Bloop (e.g. 'system|11', 'temurin:17', …)

--bloop-working-dir

Working directory for Bloop, if it needs to be started

--server

Enable / disable usage of Bloop compilation server. Bloop is used by default so use --server:false to disable it. Disabling compilation server allows to test compilation in more controlled mannter (no caching or incremental compiler) but has a detrimental effect of performance.

--home-directory

Override the path to user's home directory

Aliases: --home

--scalac-option

Add a scalac option. Note that options starting with -g, -language, -opt, -P, -target, -V, -W, -X, and -Y are assumed to be Scala compiler options and don't require to be passed after -O or --scalac-option.

Aliases: --scala-opt ,-O ,--scala-option

--jvm-index

JVM index URL

--jvm-index-os

Operating system to use when looking up in the JVM index

--jvm-index-arch

CPU architecture to use when looking up in the JVM index

--bsp-debug-port

Port for BSP debugging

--ttl

Specify a TTL for changing dependencies, such as snapshots

--cache

Set the coursier cache location

--coursier-validate-checksums

Enable checksum validation of artifacts downloaded by coursier

--workspace

Directory where .scala-build is written

--scalac-help

Show help for scalac. This is an alias for --scalac-option -help

Aliases: --help-scalac

--scalac-verbose

Turn verbosity on for scalac. This is an alias for --scalac-option -verbose

Aliases: --verbose-scalac

--execute-scala

A synonym to --scala-snippet, which defaults the sub-command to run when no sub-command is passed explicitly

--java-snippet

Allows to execute a passed string as Java code

--execute-java

A synonym to --scala-snippet, which defaults the sub-command to run when no sub-command is passed explicitly

--scala-library

--java

Do not add dependency to Scala Standard library. This is useful, when Scala CLI works with pure Java projects.

--runner

Should include Scala CLI runner on the runtime ClassPath. Runner is added by default for application running on JVM using standard Scala versions. Runner is used to make stack traces more readable in case of application failure.

--add-stubs

Add dependency for stubs needed to make $ivy and $dep imports to work.

--default-forbidden-directories

--forbid

--help-js

Show options for ScalaJS

--help-native

Show options for ScalaNative

--strict-bloop-json-check

---

help command

MUST have for Scala Runner specification.

Print help message

Implementantation specific options

--usage

Print usage and exit

--help

Print help message and exit

Aliases: -h ,-help

--help-full

Print help message, including hidden options, and exit

Aliases: --full-help

---

repl command

MUST have for Scala Runner specification.

Aliases: console

Fire-up a Scala REPL

MUST have options

--dependency

Add dependencies

Aliases: --dep

--compiler-plugin

Add compiler plugin dependencies

Aliases: -P ,--plugin

--scala-version

Set the Scala version

Aliases: --scala ,-S

--scala-binary-version

Set the Scala binary version

Aliases: --scala-binary ,--scala-bin ,-B

--extra-jars

Add extra JARs and compiled classes to the class path

Aliases: --jar ,--jars ,--extra-jar ,--class ,--extra-class ,--classes ,--extra-classes ,-classpath ,-cp ,--classpath ,--class-path ,--extra-class-path

--resource-dirs

Add a resource directory

Aliases: --resource-dir

--compilation-output

Copy compilation results to output directory using either relative or absolute path

Aliases: --output-directory ,-d ,--destination ,--compile-output ,--compile-out

--java-opt

Set Java options, such as -Xmx1g

Aliases: -J

--java-prop

Set Java properties

SHOULD have options

--js

Enable Scala.js. To show more options for Scala.js pass --help-js

--js-version

The Scala.js version

--js-mode

The Scala.js mode, either dev or release

--js-module-kind

The Scala.js module kind: commonjs/common, esmodule/es, nomodule/none

--js-check-ir

--js-emit-source-maps

Emit source maps

--js-source-maps-path

Set the destination path of source maps

--js-dom

Enable jsdom

--js-header

A header that will be added at the top of generated .js files

--js-es-version

The Scala.js ECMA Script version: es5_1, es2015, es2016, es2017, es2018, es2019, es2020, es2021

--native

Enable Scala Native. To show more options for Scala Native pass --help-native

--native-version

Set the Scala Native version

--native-mode

Set Scala Native compilation mode

--native-gc

Set the Scala Native garbage collector

--native-linking

Extra options passed to clang verbatim during linking

--native-compile

List of compile options

--embed-resources

Embed resources into the Scala Native binary (can be read with the Java resources API)

--repository

Add repositories

Aliases: --repo ,-r

--debug

Turn debugging on

--debug-port

Debug port (5005 by default)

--debug-mode

Debug mode (attach by default)

--java-home

Set the Java home directory

--jvm

Use a specific JVM, such as 14, adopt:11, or graalvm:21, or system

Aliases: -j

--javac-plugin

Javac plugin dependencies or files

--javac-option

Javac options

Aliases: --javac-opt

--script-snippet

Allows to execute a passed string as a Scala script

--execute-script

A synonym to --script-snippet, which defaults the sub-command to run when no sub-command is passed explicitly

Aliases: --execute-scala-script ,--execute-sc ,-e

--scala-snippet

Allows to execute a passed string as Scala code

--extra-compile-only-jars

Add extra JARs in the compilaion class path. Mainly using to run code in managed environments like Spark not to include certain depenencies on runtime ClassPath.

Aliases: --compile-only-jar ,--compile-only-jars ,--extra-compile-only-jar

--extra-source-jars

Add extra source JARs

Aliases: --source-jar ,--source-jars ,--extra-source-jar

--platform

Specify platform

--semantic-db

Generate SemanticDBs

--watch

Watch source files for changes

Aliases: -w

--restart

Run your application in background and automatically restart if sources have been changed

Aliases: --revolver

Implementantation specific options

--usage

Print usage and exit

--help

Print help message and exit

Aliases: -h ,-help

--help-full

Print help message, including hidden options, and exit

Aliases: --full-help

--verbose

Increase verbosity (can be specified multiple times)

Aliases: -v

--interactive

Interactive mode

Aliases: -i

--actions

Enable actionable diagnostics

--quiet

Decrease verbosity

Aliases: -q

--progress

Use progress bars

--js-allow-big-ints-for-longs

Primitive Longs may be compiled as primitive JavaScript bigints

--js-avoid-classes

Avoid class'es when using functions and prototypes has the same observable semantics.

--js-avoid-lets-and-consts

Avoid lets and consts when using vars has the same observable semantics.

--js-module-split-style

The Scala.js module split style: fewestmodules, smallestmodules, smallmodulesfor

--js-small-module-for-package

Create as many small modules as possible for the classes in the passed packages and their subpackages.

--js-linker-path

Path to the Scala.js linker

--js-cli-version

Scala.js CLI version to use for linking

--js-cli-java-arg

Scala.js CLI Java options

--js-cli-on-jvm

Whether to run the Scala.js CLI on the JVM or using a native executable

--native-clang

Path to the Clang command

--native-clangpp

Path to the Clang++ command

--native-linking-defaults

Use default linking settings

--native-compile-defaults

Use default compile options

--bloop-bsp-protocol

Protocol to use to open a BSP connection with Bloop

--bloop-bsp-socket

Socket file to use to open a BSP connection with Bloop

--bloop-host

Host the compilation server should bind to

--bloop-port

Port the compilation server should bind to (pass -1 to pick a random port)

--bloop-daemon-dir

Daemon directory of the Bloop daemon (directory with lock, pid, and socket files)

--bloop-version

If Bloop isn't already running, the version we should start

--bloop-bsp-timeout

Maximum duration to wait for the BSP connection to be opened

--bloop-bsp-check-period

Duration between checks of the BSP connection state

--bloop-startup-timeout

Maximum duration to wait for the compilation server to start up

--bloop-default-java-opts

Include default JVM options for Bloop

--bloop-java-opt

Pass java options to use by Bloop server

--bloop-global-options-file

Bloop global options file

--bloop-jvm

JVM to use to start Bloop (e.g. 'system|11', 'temurin:17', …)

--bloop-working-dir

Working directory for Bloop, if it needs to be started

--server

Enable / disable usage of Bloop compilation server. Bloop is used by default so use --server:false to disable it. Disabling compilation server allows to test compilation in more controlled mannter (no caching or incremental compiler) but has a detrimental effect of performance.

--home-directory

Override the path to user's home directory

Aliases: --home

--scalac-option

Add a scalac option. Note that options starting with -g, -language, -opt, -P, -target, -V, -W, -X, and -Y are assumed to be Scala compiler options and don't require to be passed after -O or --scalac-option.

Aliases: --scala-opt ,-O ,--scala-option

--jvm-index

JVM index URL

--jvm-index-os

Operating system to use when looking up in the JVM index

--jvm-index-arch

CPU architecture to use when looking up in the JVM index

--bsp-debug-port

Port for BSP debugging

--ttl

Specify a TTL for changing dependencies, such as snapshots

--cache

Set the coursier cache location

--coursier-validate-checksums

Enable checksum validation of artifacts downloaded by coursier

--workspace

Directory where .scala-build is written

--scalac-help

Show help for scalac. This is an alias for --scalac-option -help

Aliases: --help-scalac

--scalac-verbose

Turn verbosity on for scalac. This is an alias for --scalac-option -verbose

Aliases: --verbose-scalac

--execute-scala

A synonym to --scala-snippet, which defaults the sub-command to run when no sub-command is passed explicitly

--java-snippet

Allows to execute a passed string as Java code

--execute-java

A synonym to --scala-snippet, which defaults the sub-command to run when no sub-command is passed explicitly

--scala-library

--java

Do not add dependency to Scala Standard library. This is useful, when Scala CLI works with pure Java projects.

--runner

Should include Scala CLI runner on the runtime ClassPath. Runner is added by default for application running on JVM using standard Scala versions. Runner is used to make stack traces more readable in case of application failure.

--add-stubs

Add dependency for stubs needed to make $ivy and $dep imports to work.

--default-forbidden-directories

--forbid

--help-js

Show options for ScalaJS

--help-native

Show options for ScalaNative

--strict-bloop-json-check

--repl-dry-run

Don't actually run the REPL, just fetch it

---

run command

MUST have for Scala Runner specification.

Compile and run Scala code.

To pass arguments to the application, just add them after --, like:

scala-cli MyApp.scala -- first-arg second-arg

MUST have options

--dependency

Add dependencies

Aliases: --dep

--compiler-plugin

Add compiler plugin dependencies

Aliases: -P ,--plugin

--scala-version

Set the Scala version

Aliases: --scala ,-S

--scala-binary-version

Set the Scala binary version

Aliases: --scala-binary ,--scala-bin ,-B

--extra-jars

Add extra JARs and compiled classes to the class path

Aliases: --jar ,--jars ,--extra-jar ,--class ,--extra-class ,--classes ,--extra-classes ,-classpath ,-cp ,--classpath ,--class-path ,--extra-class-path

--resource-dirs

Add a resource directory

Aliases: --resource-dir

--compilation-output

Copy compilation results to output directory using either relative or absolute path

Aliases: --output-directory ,-d ,--destination ,--compile-output ,--compile-out

--java-opt

Set Java options, such as -Xmx1g

Aliases: -J

--java-prop

Set Java properties

--main-class

Specify which main class to run

Aliases: -M

SHOULD have options

--js

Enable Scala.js. To show more options for Scala.js pass --help-js

--js-version

The Scala.js version

--js-mode

The Scala.js mode, either dev or release

--js-module-kind

The Scala.js module kind: commonjs/common, esmodule/es, nomodule/none

--js-check-ir

--js-emit-source-maps

Emit source maps

--js-source-maps-path

Set the destination path of source maps

--js-dom

Enable jsdom

--js-header

A header that will be added at the top of generated .js files

--js-es-version

The Scala.js ECMA Script version: es5_1, es2015, es2016, es2017, es2018, es2019, es2020, es2021

--native

Enable Scala Native. To show more options for Scala Native pass --help-native

--native-version

Set the Scala Native version

--native-mode

Set Scala Native compilation mode

--native-gc

Set the Scala Native garbage collector

--native-linking

Extra options passed to clang verbatim during linking

--native-compile

List of compile options

--embed-resources

Embed resources into the Scala Native binary (can be read with the Java resources API)

--repository

Add repositories

Aliases: --repo ,-r

--debug

Turn debugging on

--debug-port

Debug port (5005 by default)

--debug-mode

Debug mode (attach by default)

--java-home

Set the Java home directory

--jvm

Use a specific JVM, such as 14, adopt:11, or graalvm:21, or system

Aliases: -j

--javac-plugin

Javac plugin dependencies or files

--javac-option

Javac options

Aliases: --javac-opt

--script-snippet

Allows to execute a passed string as a Scala script

--execute-script

A synonym to --script-snippet, which defaults the sub-command to run when no sub-command is passed explicitly

Aliases: --execute-scala-script ,--execute-sc ,-e

--scala-snippet

Allows to execute a passed string as Scala code

--extra-compile-only-jars

Add extra JARs in the compilaion class path. Mainly using to run code in managed environments like Spark not to include certain depenencies on runtime ClassPath.

Aliases: --compile-only-jar ,--compile-only-jars ,--extra-compile-only-jar

--extra-source-jars

Add extra source JARs

Aliases: --source-jar ,--source-jars ,--extra-source-jar

--platform

Specify platform

--semantic-db

Generate SemanticDBs

--watch

Watch source files for changes

Aliases: -w

--restart

Run your application in background and automatically restart if sources have been changed

Aliases: --revolver

--main-class-ls

List main classes available in the current context

Aliases: --main-class-list ,--list-main-class ,--list-main-classes

--command

Print the command that would have been run (one argument per line), rather than running it

Implementantation specific options

--usage

Print usage and exit

--help

Print help message and exit

Aliases: -h ,-help

--help-full

Print help message, including hidden options, and exit

Aliases: --full-help

--verbose

Increase verbosity (can be specified multiple times)

Aliases: -v

--interactive

Interactive mode

Aliases: -i

--actions

Enable actionable diagnostics

--quiet

Decrease verbosity

Aliases: -q

--progress

Use progress bars

--js-allow-big-ints-for-longs

Primitive Longs may be compiled as primitive JavaScript bigints

--js-avoid-classes

Avoid class'es when using functions and prototypes has the same observable semantics.

--js-avoid-lets-and-consts

Avoid lets and consts when using vars has the same observable semantics.

--js-module-split-style

The Scala.js module split style: fewestmodules, smallestmodules, smallmodulesfor

--js-small-module-for-package

Create as many small modules as possible for the classes in the passed packages and their subpackages.

--js-linker-path

Path to the Scala.js linker

--js-cli-version

Scala.js CLI version to use for linking

--js-cli-java-arg

Scala.js CLI Java options

--js-cli-on-jvm

Whether to run the Scala.js CLI on the JVM or using a native executable

--native-clang

Path to the Clang command

--native-clangpp

Path to the Clang++ command

--native-linking-defaults

Use default linking settings

--native-compile-defaults

Use default compile options

--bloop-bsp-protocol

Protocol to use to open a BSP connection with Bloop

--bloop-bsp-socket

Socket file to use to open a BSP connection with Bloop

--bloop-host

Host the compilation server should bind to

--bloop-port

Port the compilation server should bind to (pass -1 to pick a random port)

--bloop-daemon-dir

Daemon directory of the Bloop daemon (directory with lock, pid, and socket files)

--bloop-version

If Bloop isn't already running, the version we should start

--bloop-bsp-timeout

Maximum duration to wait for the BSP connection to be opened

--bloop-bsp-check-period

Duration between checks of the BSP connection state

--bloop-startup-timeout

Maximum duration to wait for the compilation server to start up

--bloop-default-java-opts

Include default JVM options for Bloop

--bloop-java-opt

Pass java options to use by Bloop server

--bloop-global-options-file

Bloop global options file

--bloop-jvm

JVM to use to start Bloop (e.g. 'system|11', 'temurin:17', …)

--bloop-working-dir

Working directory for Bloop, if it needs to be started

--server

Enable / disable usage of Bloop compilation server. Bloop is used by default so use --server:false to disable it. Disabling compilation server allows to test compilation in more controlled mannter (no caching or incremental compiler) but has a detrimental effect of performance.

--home-directory

Override the path to user's home directory

Aliases: --home

--scalac-option

Add a scalac option. Note that options starting with -g, -language, -opt, -P, -target, -V, -W, -X, and -Y are assumed to be Scala compiler options and don't require to be passed after -O or --scalac-option.

Aliases: --scala-opt ,-O ,--scala-option

--jvm-index

JVM index URL

--jvm-index-os

Operating system to use when looking up in the JVM index

--jvm-index-arch

CPU architecture to use when looking up in the JVM index

--bsp-debug-port

Port for BSP debugging

--ttl

Specify a TTL for changing dependencies, such as snapshots

--cache

Set the coursier cache location

--coursier-validate-checksums

Enable checksum validation of artifacts downloaded by coursier

--workspace

Directory where .scala-build is written

--scalac-help

Show help for scalac. This is an alias for --scalac-option -help

Aliases: --help-scalac

--scalac-verbose

Turn verbosity on for scalac. This is an alias for --scalac-option -verbose

Aliases: --verbose-scalac

--execute-scala

A synonym to --scala-snippet, which defaults the sub-command to run when no sub-command is passed explicitly

--java-snippet

Allows to execute a passed string as Java code

--execute-java

A synonym to --scala-snippet, which defaults the sub-command to run when no sub-command is passed explicitly

--scala-library

--java

Do not add dependency to Scala Standard library. This is useful, when Scala CLI works with pure Java projects.

--runner

Should include Scala CLI runner on the runtime ClassPath. Runner is added by default for application running on JVM using standard Scala versions. Runner is used to make stack traces more readable in case of application failure.

--add-stubs

Add dependency for stubs needed to make $ivy and $dep imports to work.

--default-forbidden-directories

--forbid

--help-js

Show options for ScalaJS

--help-native

Show options for ScalaNative

--strict-bloop-json-check

--scratch-dir

Temporary / working directory where to write generated launchers

--use-manifest

Run Java commands using a manifest-based class path (shortens command length)

---

SHOULD have commands

about command

SHOULD have for Scala Runner specification.

Print details about this application

Implementantation specific options

--usage

Print usage and exit

--help

Print help message and exit

Aliases: -h ,-help

--help-full

Print help message, including hidden options, and exit

Aliases: --full-help

--verbose

Increase verbosity (can be specified multiple times)

Aliases: -v

--interactive

Interactive mode

Aliases: -i

--actions

Enable actionable diagnostics

--gh-token

A github token used to access GitHub. Not needed in most cases.

---

fmt command

SHOULD have for Scala Runner specification.

Aliases: format, scalafmt

Format Scala code

MUST have options

--dependency

Add dependencies

Aliases: --dep

--compiler-plugin

Add compiler plugin dependencies

Aliases: -P ,--plugin

--scala-version

Set the Scala version

Aliases: --scala ,-S

--scala-binary-version

Set the Scala binary version

Aliases: --scala-binary ,--scala-bin ,-B

--extra-jars

Add extra JARs and compiled classes to the class path

Aliases: --jar ,--jars ,--extra-jar ,--class ,--extra-class ,--classes ,--extra-classes ,-classpath ,-cp ,--classpath ,--class-path ,--extra-class-path

--resource-dirs

Add a resource directory

Aliases: --resource-dir

--compilation-output

Copy compilation results to output directory using either relative or absolute path

Aliases: --output-directory ,-d ,--destination ,--compile-output ,--compile-out

SHOULD have options

--js

Enable Scala.js. To show more options for Scala.js pass --help-js

--js-version

The Scala.js version

--js-mode

The Scala.js mode, either dev or release

--js-module-kind

The Scala.js module kind: commonjs/common, esmodule/es, nomodule/none

--js-check-ir

--js-emit-source-maps

Emit source maps

--js-source-maps-path

Set the destination path of source maps

--js-dom

Enable jsdom

--js-header

A header that will be added at the top of generated .js files

--js-es-version

The Scala.js ECMA Script version: es5_1, es2015, es2016, es2017, es2018, es2019, es2020, es2021

--native

Enable Scala Native. To show more options for Scala Native pass --help-native

--native-version

Set the Scala Native version

--native-mode

Set Scala Native compilation mode

--native-gc

Set the Scala Native garbage collector

--native-linking

Extra options passed to clang verbatim during linking

--native-compile

List of compile options

--embed-resources

Embed resources into the Scala Native binary (can be read with the Java resources API)

--repository

Add repositories

Aliases: --repo ,-r

--debug

Turn debugging on

--debug-port

Debug port (5005 by default)

--debug-mode

Debug mode (attach by default)

--java-home

Set the Java home directory

--jvm

Use a specific JVM, such as 14, adopt:11, or graalvm:21, or system

Aliases: -j

--javac-plugin

Javac plugin dependencies or files

--javac-option

Javac options

Aliases: --javac-opt

--script-snippet

Allows to execute a passed string as a Scala script

--execute-script

A synonym to --script-snippet, which defaults the sub-command to run when no sub-command is passed explicitly

Aliases: --execute-scala-script ,--execute-sc ,-e

--scala-snippet

Allows to execute a passed string as Scala code

--extra-compile-only-jars

Add extra JARs in the compilaion class path. Mainly using to run code in managed environments like Spark not to include certain depenencies on runtime ClassPath.

Aliases: --compile-only-jar ,--compile-only-jars ,--extra-compile-only-jar

--extra-source-jars

Add extra source JARs

Aliases: --source-jar ,--source-jars ,--extra-source-jar

--platform

Specify platform

--semantic-db

Generate SemanticDBs

--check

Check if sources are well formatted

Implementantation specific options

--usage

Print usage and exit

--help

Print help message and exit

Aliases: -h ,-help

--help-full

Print help message, including hidden options, and exit

Aliases: --full-help

--verbose

Increase verbosity (can be specified multiple times)

Aliases: -v

--interactive

Interactive mode

Aliases: -i

--actions

Enable actionable diagnostics

--quiet

Decrease verbosity

Aliases: -q

--progress

Use progress bars

--js-allow-big-ints-for-longs

Primitive Longs may be compiled as primitive JavaScript bigints

--js-avoid-classes

Avoid class'es when using functions and prototypes has the same observable semantics.

--js-avoid-lets-and-consts

Avoid lets and consts when using vars has the same observable semantics.

--js-module-split-style

The Scala.js module split style: fewestmodules, smallestmodules, smallmodulesfor

--js-small-module-for-package

Create as many small modules as possible for the classes in the passed packages and their subpackages.

--js-linker-path

Path to the Scala.js linker

--js-cli-version

Scala.js CLI version to use for linking

--js-cli-java-arg

Scala.js CLI Java options

--js-cli-on-jvm

Whether to run the Scala.js CLI on the JVM or using a native executable

--native-clang

Path to the Clang command

--native-clangpp

Path to the Clang++ command

--native-linking-defaults

Use default linking settings

--native-compile-defaults

Use default compile options

--bloop-bsp-protocol

Protocol to use to open a BSP connection with Bloop

--bloop-bsp-socket

Socket file to use to open a BSP connection with Bloop

--bloop-host

Host the compilation server should bind to

--bloop-port

Port the compilation server should bind to (pass -1 to pick a random port)

--bloop-daemon-dir

Daemon directory of the Bloop daemon (directory with lock, pid, and socket files)

--bloop-version

If Bloop isn't already running, the version we should start

--bloop-bsp-timeout

Maximum duration to wait for the BSP connection to be opened

--bloop-bsp-check-period

Duration between checks of the BSP connection state

--bloop-startup-timeout

Maximum duration to wait for the compilation server to start up

--bloop-default-java-opts

Include default JVM options for Bloop

--bloop-java-opt

Pass java options to use by Bloop server

--bloop-global-options-file

Bloop global options file

--bloop-jvm

JVM to use to start Bloop (e.g. 'system|11', 'temurin:17', …)

--bloop-working-dir

Working directory for Bloop, if it needs to be started

--server

Enable / disable usage of Bloop compilation server. Bloop is used by default so use --server:false to disable it. Disabling compilation server allows to test compilation in more controlled mannter (no caching or incremental compiler) but has a detrimental effect of performance.

--home-directory

Override the path to user's home directory

Aliases: --home

--scalac-option

Add a scalac option. Note that options starting with -g, -language, -opt, -P, -target, -V, -W, -X, and -Y are assumed to be Scala compiler options and don't require to be passed after -O or --scalac-option.

Aliases: --scala-opt ,-O ,--scala-option

--jvm-index

JVM index URL

--jvm-index-os

Operating system to use when looking up in the JVM index

--jvm-index-arch

CPU architecture to use when looking up in the JVM index

--bsp-debug-port

Port for BSP debugging

--ttl

Specify a TTL for changing dependencies, such as snapshots

--cache

Set the coursier cache location

--coursier-validate-checksums

Enable checksum validation of artifacts downloaded by coursier

--workspace

Directory where .scala-build is written

--scalac-help

Show help for scalac. This is an alias for --scalac-option -help

Aliases: --help-scalac

--scalac-verbose

Turn verbosity on for scalac. This is an alias for --scalac-option -verbose

Aliases: --verbose-scalac

--execute-scala

A synonym to --scala-snippet, which defaults the sub-command to run when no sub-command is passed explicitly

--java-snippet

Allows to execute a passed string as Java code

--execute-java

A synonym to --scala-snippet, which defaults the sub-command to run when no sub-command is passed explicitly

--scala-library

--java

Do not add dependency to Scala Standard library. This is useful, when Scala CLI works with pure Java projects.

--runner

Should include Scala CLI runner on the runtime ClassPath. Runner is added by default for application running on JVM using standard Scala versions. Runner is used to make stack traces more readable in case of application failure.

--add-stubs

Add dependency for stubs needed to make $ivy and $dep imports to work.

--default-forbidden-directories

--forbid

--help-js

Show options for ScalaJS

--help-native

Show options for ScalaNative

--strict-bloop-json-check

--respect-project-filters

Use project filters defined in the configuration. Turned on by default, use --respect-project-filters:false to disable it.

--save-scalafmt-conf

Saves .scalafmt.conf file if it was created or overwritten

--scalafmt-help

Show help for scalafmt. This is an alias for --scalafmt-arg -help

Aliases: --fmt-help

--os-arch-suffix

--scalafmt-tag

--scalafmt-github-org-name

--scalafmt-extension

--scalafmt-launcher

--scalafmt-arg

Pass argument to scalafmt.

Aliases: -F

--scalafmt-conf

Custom path to the scalafmt configuration file.

Aliases: --scalafmt-config

--scalafmt-conf-str

Pass configuration as a string.

Aliases: --scalafmt-config-str ,--scalafmt-conf-snippet

--scalafmt-dialect

Pass a global dialect for scalafmt. This overrides whatever value is configured in the .scalafmt.conf file or inferred based on Scala version used.

Aliases: --dialect

--scalafmt-version

Pass scalafmt version before running it. This overrides whatever value is configured in the .scalafmt.conf file.

Aliases: --fmt-version

---

shebang command

SHOULD have for Scala Runner specification.

Like run, but more handy from shebang scripts

This command is equivalent to run, but it changes the way scala-cli parses its command-line arguments in order to be compatible with shebang scripts.

Normally, inputs and scala-cli options can be mixed. Program have to be specified after --

scala-cli [command] [scala_cli_options | input]... -- [program_arguments]...

Contrary, for shebang command, only a single input file can be set, all scala-cli options have to be set before the input file, and program arguments after the input file

scala-cli shebang [scala_cli_options]... input [program_arguments]...

Using this, it is possible to conveniently set up Unix shebang scripts. For example:

#!/usr/bin/env -S scala-cli shebang --scala-version 2.13
println("Hello, world)

MUST have options

--dependency

Add dependencies

Aliases: --dep

--compiler-plugin

Add compiler plugin dependencies

Aliases: -P ,--plugin

--scala-version

Set the Scala version

Aliases: --scala ,-S

--scala-binary-version

Set the Scala binary version

Aliases: --scala-binary ,--scala-bin ,-B

--extra-jars

Add extra JARs and compiled classes to the class path

Aliases: --jar ,--jars ,--extra-jar ,--class ,--extra-class ,--classes ,--extra-classes ,-classpath ,-cp ,--classpath ,--class-path ,--extra-class-path

--resource-dirs

Add a resource directory

Aliases: --resource-dir

--compilation-output

Copy compilation results to output directory using either relative or absolute path

Aliases: --output-directory ,-d ,--destination ,--compile-output ,--compile-out

--java-opt

Set Java options, such as -Xmx1g

Aliases: -J

--java-prop

Set Java properties

--main-class

Specify which main class to run

Aliases: -M

SHOULD have options

--js

Enable Scala.js. To show more options for Scala.js pass --help-js

--js-version

The Scala.js version

--js-mode

The Scala.js mode, either dev or release

--js-module-kind

The Scala.js module kind: commonjs/common, esmodule/es, nomodule/none

--js-check-ir

--js-emit-source-maps

Emit source maps

--js-source-maps-path

Set the destination path of source maps

--js-dom

Enable jsdom

--js-header

A header that will be added at the top of generated .js files

--js-es-version

The Scala.js ECMA Script version: es5_1, es2015, es2016, es2017, es2018, es2019, es2020, es2021

--native

Enable Scala Native. To show more options for Scala Native pass --help-native

--native-version

Set the Scala Native version

--native-mode

Set Scala Native compilation mode

--native-gc

Set the Scala Native garbage collector

--native-linking

Extra options passed to clang verbatim during linking

--native-compile

List of compile options

--embed-resources

Embed resources into the Scala Native binary (can be read with the Java resources API)

--repository

Add repositories

Aliases: --repo ,-r

--debug

Turn debugging on

--debug-port

Debug port (5005 by default)

--debug-mode

Debug mode (attach by default)

--java-home

Set the Java home directory

--jvm

Use a specific JVM, such as 14, adopt:11, or graalvm:21, or system

Aliases: -j

--javac-plugin

Javac plugin dependencies or files

--javac-option

Javac options

Aliases: --javac-opt

--script-snippet

Allows to execute a passed string as a Scala script

--execute-script

A synonym to --script-snippet, which defaults the sub-command to run when no sub-command is passed explicitly

Aliases: --execute-scala-script ,--execute-sc ,-e

--scala-snippet

Allows to execute a passed string as Scala code

--extra-compile-only-jars

Add extra JARs in the compilaion class path. Mainly using to run code in managed environments like Spark not to include certain depenencies on runtime ClassPath.

Aliases: --compile-only-jar ,--compile-only-jars ,--extra-compile-only-jar

--extra-source-jars

Add extra source JARs

Aliases: --source-jar ,--source-jars ,--extra-source-jar

--platform

Specify platform

--semantic-db

Generate SemanticDBs

--watch

Watch source files for changes

Aliases: -w

--restart

Run your application in background and automatically restart if sources have been changed

Aliases: --revolver

--main-class-ls

List main classes available in the current context

Aliases: --main-class-list ,--list-main-class ,--list-main-classes

--command

Print the command that would have been run (one argument per line), rather than running it

Implementantation specific options

--usage

Print usage and exit

--help

Print help message and exit

Aliases: -h ,-help

--help-full

Print help message, including hidden options, and exit

Aliases: --full-help

--verbose

Increase verbosity (can be specified multiple times)

Aliases: -v

--interactive

Interactive mode

Aliases: -i

--actions

Enable actionable diagnostics

--quiet

Decrease verbosity

Aliases: -q

--progress

Use progress bars

--js-allow-big-ints-for-longs

Primitive Longs may be compiled as primitive JavaScript bigints

--js-avoid-classes

Avoid class'es when using functions and prototypes has the same observable semantics.

--js-avoid-lets-and-consts

Avoid lets and consts when using vars has the same observable semantics.

--js-module-split-style

The Scala.js module split style: fewestmodules, smallestmodules, smallmodulesfor

--js-small-module-for-package

Create as many small modules as possible for the classes in the passed packages and their subpackages.

--js-linker-path

Path to the Scala.js linker

--js-cli-version

Scala.js CLI version to use for linking

--js-cli-java-arg

Scala.js CLI Java options

--js-cli-on-jvm

Whether to run the Scala.js CLI on the JVM or using a native executable

--native-clang

Path to the Clang command

--native-clangpp

Path to the Clang++ command

--native-linking-defaults

Use default linking settings

--native-compile-defaults

Use default compile options

--bloop-bsp-protocol

Protocol to use to open a BSP connection with Bloop

--bloop-bsp-socket

Socket file to use to open a BSP connection with Bloop

--bloop-host

Host the compilation server should bind to

--bloop-port

Port the compilation server should bind to (pass -1 to pick a random port)

--bloop-daemon-dir

Daemon directory of the Bloop daemon (directory with lock, pid, and socket files)

--bloop-version

If Bloop isn't already running, the version we should start

--bloop-bsp-timeout

Maximum duration to wait for the BSP connection to be opened

--bloop-bsp-check-period

Duration between checks of the BSP connection state

--bloop-startup-timeout

Maximum duration to wait for the compilation server to start up

--bloop-default-java-opts

Include default JVM options for Bloop

--bloop-java-opt

Pass java options to use by Bloop server

--bloop-global-options-file

Bloop global options file

--bloop-jvm

JVM to use to start Bloop (e.g. 'system|11', 'temurin:17', …)

--bloop-working-dir

Working directory for Bloop, if it needs to be started

--server

Enable / disable usage of Bloop compilation server. Bloop is used by default so use --server:false to disable it. Disabling compilation server allows to test compilation in more controlled mannter (no caching or incremental compiler) but has a detrimental effect of performance.

--home-directory

Override the path to user's home directory

Aliases: --home

--scalac-option

Add a scalac option. Note that options starting with -g, -language, -opt, -P, -target, -V, -W, -X, and -Y are assumed to be Scala compiler options and don't require to be passed after -O or --scalac-option.

Aliases: --scala-opt ,-O ,--scala-option

--jvm-index

JVM index URL

--jvm-index-os

Operating system to use when looking up in the JVM index

--jvm-index-arch

CPU architecture to use when looking up in the JVM index

--bsp-debug-port

Port for BSP debugging

--ttl

Specify a TTL for changing dependencies, such as snapshots

--cache

Set the coursier cache location

--coursier-validate-checksums

Enable checksum validation of artifacts downloaded by coursier

--workspace

Directory where .scala-build is written

--scalac-help

Show help for scalac. This is an alias for --scalac-option -help

Aliases: --help-scalac

--scalac-verbose

Turn verbosity on for scalac. This is an alias for --scalac-option -verbose

Aliases: --verbose-scalac

--execute-scala

A synonym to --scala-snippet, which defaults the sub-command to run when no sub-command is passed explicitly

--java-snippet

Allows to execute a passed string as Java code

--execute-java

A synonym to --scala-snippet, which defaults the sub-command to run when no sub-command is passed explicitly

--scala-library

--java

Do not add dependency to Scala Standard library. This is useful, when Scala CLI works with pure Java projects.

--runner

Should include Scala CLI runner on the runtime ClassPath. Runner is added by default for application running on JVM using standard Scala versions. Runner is used to make stack traces more readable in case of application failure.

--add-stubs

Add dependency for stubs needed to make $ivy and $dep imports to work.

--default-forbidden-directories

--forbid

--help-js

Show options for ScalaJS

--help-native

Show options for ScalaNative

--strict-bloop-json-check

--scratch-dir

Temporary / working directory where to write generated launchers

--use-manifest

Run Java commands using a manifest-based class path (shortens command length)

---

test command

SHOULD have for Scala Runner specification.

Compile and test Scala code

MUST have options

--dependency

Add dependencies

Aliases: --dep

--compiler-plugin

Add compiler plugin dependencies

Aliases: -P ,--plugin

--scala-version

Set the Scala version

Aliases: --scala ,-S

--scala-binary-version

Set the Scala binary version

Aliases: --scala-binary ,--scala-bin ,-B

--extra-jars

Add extra JARs and compiled classes to the class path

Aliases: --jar ,--jars ,--extra-jar ,--class ,--extra-class ,--classes ,--extra-classes ,-classpath ,-cp ,--classpath ,--class-path ,--extra-class-path

--resource-dirs

Add a resource directory

Aliases: --resource-dir

--compilation-output

Copy compilation results to output directory using either relative or absolute path

Aliases: --output-directory ,-d ,--destination ,--compile-output ,--compile-out

--java-opt

Set Java options, such as -Xmx1g

Aliases: -J

--java-prop

Set Java properties

SHOULD have options

--js

Enable Scala.js. To show more options for Scala.js pass --help-js

--js-version

The Scala.js version

--js-mode

The Scala.js mode, either dev or release

--js-module-kind

The Scala.js module kind: commonjs/common, esmodule/es, nomodule/none

--js-check-ir

--js-emit-source-maps

Emit source maps

--js-source-maps-path

Set the destination path of source maps

--js-dom

Enable jsdom

--js-header

A header that will be added at the top of generated .js files

--js-es-version

The Scala.js ECMA Script version: es5_1, es2015, es2016, es2017, es2018, es2019, es2020, es2021

--native

Enable Scala Native. To show more options for Scala Native pass --help-native

--native-version

Set the Scala Native version

--native-mode

Set Scala Native compilation mode

--native-gc

Set the Scala Native garbage collector

--native-linking

Extra options passed to clang verbatim during linking

--native-compile

List of compile options

--embed-resources

Embed resources into the Scala Native binary (can be read with the Java resources API)

--repository

Add repositories

Aliases: --repo ,-r

--debug

Turn debugging on

--debug-port

Debug port (5005 by default)

--debug-mode

Debug mode (attach by default)

--java-home

Set the Java home directory

--jvm

Use a specific JVM, such as 14, adopt:11, or graalvm:21, or system

Aliases: -j

--javac-plugin

Javac plugin dependencies or files

--javac-option

Javac options

Aliases: --javac-opt

--script-snippet

Allows to execute a passed string as a Scala script

--execute-script

A synonym to --script-snippet, which defaults the sub-command to run when no sub-command is passed explicitly

Aliases: --execute-scala-script ,--execute-sc ,-e

--scala-snippet

Allows to execute a passed string as Scala code

--extra-compile-only-jars

Add extra JARs in the compilaion class path. Mainly using to run code in managed environments like Spark not to include certain depenencies on runtime ClassPath.

Aliases: --compile-only-jar ,--compile-only-jars ,--extra-compile-only-jar

--extra-source-jars

Add extra source JARs

Aliases: --source-jar ,--source-jars ,--extra-source-jar

--platform

Specify platform

--semantic-db

Generate SemanticDBs

--watch

Watch source files for changes

Aliases: -w

--restart

Run your application in background and automatically restart if sources have been changed

Aliases: --revolver

--test-framework

Name of the test framework's runner class to use while running tests

--require-tests

Fail if no test suites were run

Implementantation specific options

--usage

Print usage and exit

--help

Print help message and exit

Aliases: -h ,-help

--help-full

Print help message, including hidden options, and exit

Aliases: --full-help

--verbose

Increase verbosity (can be specified multiple times)

Aliases: -v

--interactive

Interactive mode

Aliases: -i

--actions

Enable actionable diagnostics

--quiet

Decrease verbosity

Aliases: -q

--progress

Use progress bars

--js-allow-big-ints-for-longs

Primitive Longs may be compiled as primitive JavaScript bigints

--js-avoid-classes

Avoid class'es when using functions and prototypes has the same observable semantics.

--js-avoid-lets-and-consts

Avoid lets and consts when using vars has the same observable semantics.

--js-module-split-style

The Scala.js module split style: fewestmodules, smallestmodules, smallmodulesfor

--js-small-module-for-package

Create as many small modules as possible for the classes in the passed packages and their subpackages.

--js-linker-path

Path to the Scala.js linker

--js-cli-version

Scala.js CLI version to use for linking

--js-cli-java-arg

Scala.js CLI Java options

--js-cli-on-jvm

Whether to run the Scala.js CLI on the JVM or using a native executable

--native-clang

Path to the Clang command

--native-clangpp

Path to the Clang++ command

--native-linking-defaults

Use default linking settings

--native-compile-defaults

Use default compile options

--bloop-bsp-protocol

Protocol to use to open a BSP connection with Bloop

--bloop-bsp-socket

Socket file to use to open a BSP connection with Bloop

--bloop-host

Host the compilation server should bind to

--bloop-port

Port the compilation server should bind to (pass -1 to pick a random port)

--bloop-daemon-dir

Daemon directory of the Bloop daemon (directory with lock, pid, and socket files)

--bloop-version

If Bloop isn't already running, the version we should start

--bloop-bsp-timeout

Maximum duration to wait for the BSP connection to be opened

--bloop-bsp-check-period

Duration between checks of the BSP connection state

--bloop-startup-timeout

Maximum duration to wait for the compilation server to start up

--bloop-default-java-opts

Include default JVM options for Bloop

--bloop-java-opt

Pass java options to use by Bloop server

--bloop-global-options-file

Bloop global options file

--bloop-jvm

JVM to use to start Bloop (e.g. 'system|11', 'temurin:17', …)

--bloop-working-dir

Working directory for Bloop, if it needs to be started

--server

Enable / disable usage of Bloop compilation server. Bloop is used by default so use --server:false to disable it. Disabling compilation server allows to test compilation in more controlled mannter (no caching or incremental compiler) but has a detrimental effect of performance.

--home-directory

Override the path to user's home directory

Aliases: --home

--scalac-option

Add a scalac option. Note that options starting with -g, -language, -opt, -P, -target, -V, -W, -X, and -Y are assumed to be Scala compiler options and don't require to be passed after -O or --scalac-option.

Aliases: --scala-opt ,-O ,--scala-option

--jvm-index

JVM index URL

--jvm-index-os

Operating system to use when looking up in the JVM index

--jvm-index-arch

CPU architecture to use when looking up in the JVM index

--bsp-debug-port

Port for BSP debugging

--ttl

Specify a TTL for changing dependencies, such as snapshots

--cache

Set the coursier cache location

--coursier-validate-checksums

Enable checksum validation of artifacts downloaded by coursier

--workspace

Directory where .scala-build is written

--scalac-help

Show help for scalac. This is an alias for --scalac-option -help

Aliases: --help-scalac

--scalac-verbose

Turn verbosity on for scalac. This is an alias for --scalac-option -verbose

Aliases: --verbose-scalac

--execute-scala

A synonym to --scala-snippet, which defaults the sub-command to run when no sub-command is passed explicitly

--java-snippet

Allows to execute a passed string as Java code

--execute-java

A synonym to --scala-snippet, which defaults the sub-command to run when no sub-command is passed explicitly

--scala-library

--java

Do not add dependency to Scala Standard library. This is useful, when Scala CLI works with pure Java projects.

--runner

Should include Scala CLI runner on the runtime ClassPath. Runner is added by default for application running on JVM using standard Scala versions. Runner is used to make stack traces more readable in case of application failure.

--add-stubs

Add dependency for stubs needed to make $ivy and $dep imports to work.

--default-forbidden-directories

--forbid

--help-js

Show options for ScalaJS

--help-native

Show options for ScalaNative

--strict-bloop-json-check

---

version command

SHOULD have for Scala Runner specification.

Print scala-cli version

Implementantation specific options

--usage

Print usage and exit

--help

Print help message and exit

Aliases: -h ,-help

--help-full

Print help message, including hidden options, and exit

Aliases: --full-help

--verbose

Increase verbosity (can be specified multiple times)

Aliases: -v

--interactive

Interactive mode

Aliases: -i

--actions

Enable actionable diagnostics

--cli-version

Show only plain scala-cli version

Aliases: --cli

--scala-version

Show only plain scala version

Aliases: --scala

---

IMPLEMENTATION specific commands

bsp command

IMPLEMENTATION specific for Scala Runner specification.

Start BSP server

MUST have options

--dependency

Add dependencies

Aliases: --dep

--compiler-plugin

Add compiler plugin dependencies

Aliases: -P ,--plugin

--scala-version

Set the Scala version

Aliases: --scala ,-S

--scala-binary-version

Set the Scala binary version

Aliases: --scala-binary ,--scala-bin ,-B

--extra-jars

Add extra JARs and compiled classes to the class path

Aliases: --jar ,--jars ,--extra-jar ,--class ,--extra-class ,--classes ,--extra-classes ,-classpath ,-cp ,--classpath ,--class-path ,--extra-class-path

--resource-dirs

Add a resource directory

Aliases: --resource-dir

--compilation-output

Copy compilation results to output directory using either relative or absolute path

Aliases: --output-directory ,-d ,--destination ,--compile-output ,--compile-out

SHOULD have options

--js

Enable Scala.js. To show more options for Scala.js pass --help-js

--js-version

The Scala.js version

--js-mode

The Scala.js mode, either dev or release

--js-module-kind

The Scala.js module kind: commonjs/common, esmodule/es, nomodule/none

--js-check-ir

--js-emit-source-maps

Emit source maps

--js-source-maps-path

Set the destination path of source maps

--js-dom

Enable jsdom

--js-header

A header that will be added at the top of generated .js files

--js-es-version

The Scala.js ECMA Script version: es5_1, es2015, es2016, es2017, es2018, es2019, es2020, es2021

--native

Enable Scala Native. To show more options for Scala Native pass --help-native

--native-version

Set the Scala Native version

--native-mode

Set Scala Native compilation mode

--native-gc

Set the Scala Native garbage collector

--native-linking

Extra options passed to clang verbatim during linking

--native-compile

List of compile options

--embed-resources

Embed resources into the Scala Native binary (can be read with the Java resources API)

--repository

Add repositories

Aliases: --repo ,-r

--debug

Turn debugging on

--debug-port

Debug port (5005 by default)

--debug-mode

Debug mode (attach by default)

--java-home

Set the Java home directory

--jvm

Use a specific JVM, such as 14, adopt:11, or graalvm:21, or system

Aliases: -j

--javac-plugin

Javac plugin dependencies or files

--javac-option

Javac options

Aliases: --javac-opt

--script-snippet

Allows to execute a passed string as a Scala script

--execute-script

A synonym to --script-snippet, which defaults the sub-command to run when no sub-command is passed explicitly

Aliases: --execute-scala-script ,--execute-sc ,-e

--scala-snippet

Allows to execute a passed string as Scala code

--extra-compile-only-jars

Add extra JARs in the compilaion class path. Mainly using to run code in managed environments like Spark not to include certain depenencies on runtime ClassPath.

Aliases: --compile-only-jar ,--compile-only-jars ,--extra-compile-only-jar

--extra-source-jars

Add extra source JARs

Aliases: --source-jar ,--source-jars ,--extra-source-jar

--platform

Specify platform

--semantic-db

Generate SemanticDBs

Implementantation specific options

--usage

Print usage and exit

--help

Print help message and exit

Aliases: -h ,-help

--help-full

Print help message, including hidden options, and exit

Aliases: --full-help

--verbose

Increase verbosity (can be specified multiple times)

Aliases: -v

--interactive

Interactive mode

Aliases: -i

--actions

Enable actionable diagnostics

--quiet

Decrease verbosity

Aliases: -q

--progress

Use progress bars

--js-allow-big-ints-for-longs

Primitive Longs may be compiled as primitive JavaScript bigints

--js-avoid-classes

Avoid class'es when using functions and prototypes has the same observable semantics.

--js-avoid-lets-and-consts

Avoid lets and consts when using vars has the same observable semantics.

--js-module-split-style

The Scala.js module split style: fewestmodules, smallestmodules, smallmodulesfor

--js-small-module-for-package

Create as many small modules as possible for the classes in the passed packages and their subpackages.

--js-linker-path

Path to the Scala.js linker

--js-cli-version

Scala.js CLI version to use for linking

--js-cli-java-arg

Scala.js CLI Java options

--js-cli-on-jvm

Whether to run the Scala.js CLI on the JVM or using a native executable

--native-clang

Path to the Clang command

--native-clangpp

Path to the Clang++ command

--native-linking-defaults

Use default linking settings

--native-compile-defaults

Use default compile options

--bloop-bsp-protocol

Protocol to use to open a BSP connection with Bloop

--bloop-bsp-socket

Socket file to use to open a BSP connection with Bloop

--bloop-host

Host the compilation server should bind to

--bloop-port

Port the compilation server should bind to (pass -1 to pick a random port)

--bloop-daemon-dir

Daemon directory of the Bloop daemon (directory with lock, pid, and socket files)

--bloop-version

If Bloop isn't already running, the version we should start

--bloop-bsp-timeout

Maximum duration to wait for the BSP connection to be opened

--bloop-bsp-check-period

Duration between checks of the BSP connection state

--bloop-startup-timeout

Maximum duration to wait for the compilation server to start up

--bloop-default-java-opts

Include default JVM options for Bloop

--bloop-java-opt

Pass java options to use by Bloop server

--bloop-global-options-file

Bloop global options file

--bloop-jvm

JVM to use to start Bloop (e.g. 'system|11', 'temurin:17', …)

--bloop-working-dir

Working directory for Bloop, if it needs to be started

--server

Enable / disable usage of Bloop compilation server. Bloop is used by default so use --server:false to disable it. Disabling compilation server allows to test compilation in more controlled mannter (no caching or incremental compiler) but has a detrimental effect of performance.

--home-directory

Override the path to user's home directory

Aliases: --home

--scalac-option

Add a scalac option. Note that options starting with -g, -language, -opt, -P, -target, -V, -W, -X, and -Y are assumed to be Scala compiler options and don't require to be passed after -O or --scalac-option.

Aliases: --scala-opt ,-O ,--scala-option

--jvm-index

JVM index URL

--jvm-index-os

Operating system to use when looking up in the JVM index

--jvm-index-arch

CPU architecture to use when looking up in the JVM index

--bsp-debug-port

Port for BSP debugging

--ttl

Specify a TTL for changing dependencies, such as snapshots

--cache

Set the coursier cache location

--coursier-validate-checksums

Enable checksum validation of artifacts downloaded by coursier

--workspace

Directory where .scala-build is written

--scalac-help

Show help for scalac. This is an alias for --scalac-option -help

Aliases: --help-scalac

--scalac-verbose

Turn verbosity on for scalac. This is an alias for --scalac-option -verbose

Aliases: --verbose-scalac

--execute-scala

A synonym to --scala-snippet, which defaults the sub-command to run when no sub-command is passed explicitly

--java-snippet

Allows to execute a passed string as Java code

--execute-java

A synonym to --scala-snippet, which defaults the sub-command to run when no sub-command is passed explicitly

--scala-library

--java

Do not add dependency to Scala Standard library. This is useful, when Scala CLI works with pure Java projects.

--runner

Should include Scala CLI runner on the runtime ClassPath. Runner is added by default for application running on JVM using standard Scala versions. Runner is used to make stack traces more readable in case of application failure.

--add-stubs

Add dependency for stubs needed to make $ivy and $dep imports to work.

--default-forbidden-directories

--forbid

--help-js

Show options for ScalaJS

--help-native

Show options for ScalaNative

--strict-bloop-json-check

--json-options

Command-line options JSON file

---

clean command

IMPLEMENTATION specific for Scala Runner specification.

Clean the workspace

Implementantation specific options

--usage

Print usage and exit

--help

Print help message and exit

Aliases: -h ,-help

--help-full

Print help message, including hidden options, and exit

Aliases: --full-help

--verbose

Increase verbosity (can be specified multiple times)

Aliases: -v

--interactive

Interactive mode

Aliases: -i

--actions

Enable actionable diagnostics

--quiet

Decrease verbosity

Aliases: -q

--progress

Use progress bars

--home-directory

Override the path to user's home directory

Aliases: --home

--bsp-directory

Custom BSP configuration location

Aliases: --bsp-dir

--bsp-name

Name of BSP

Aliases: --name

--workspace

Directory where .scala-build is written

---

doctor command

IMPLEMENTATION specific for Scala Runner specification.

Print details about this application

Implementantation specific options

--usage

Print usage and exit

--help

Print help message and exit

Aliases: -h ,-help

--help-full

Print help message, including hidden options, and exit

Aliases: --full-help

--verbose

Increase verbosity (can be specified multiple times)

Aliases: -v

--interactive

Interactive mode

Aliases: -i

--actions

Enable actionable diagnostics

--gh-token

A github token used to access GitHub. Not needed in most cases.

---

install-completions command

IMPLEMENTATION specific for Scala Runner specification.

Aliases: install-completions

Installs completions into your shell

Implementantation specific options

--usage

Print usage and exit

--help

Print help message and exit

Aliases: -h ,-help

--help-full

Print help message, including hidden options, and exit

Aliases: --full-help

--verbose

Increase verbosity (can be specified multiple times)

Aliases: -v

--interactive

Interactive mode

Aliases: -i

--actions

Enable actionable diagnostics

--quiet

Decrease verbosity

Aliases: -q

--progress

Use progress bars

--home-directory

Override the path to user's home directory

Aliases: --home

--format

Name of the shell, either zsh or bash

Aliases: --shell

--rc-file

Path to *rc file, defaults to .bashrc or .zshrc depending on shell

--output

Completions output directory

Aliases: -o

--banner

Custom banner in comment placed in rc file

--name

Custom completions name

--env

Print completions to stdout

---

install-home command

IMPLEMENTATION specific for Scala Runner specification.

Install scala-cli in a sub-directory of the home directory

Implementantation specific options

--usage

Print usage and exit

--help

Print help message and exit

Aliases: -h ,-help

--help-full

Print help message, including hidden options, and exit

Aliases: --full-help

--verbose

Increase verbosity (can be specified multiple times)

Aliases: -v

--interactive

Interactive mode

Aliases: -i

--actions

Enable actionable diagnostics

--scala-cli-binary-path

--force

Overwrite scala-cli, if it exists

Aliases: -f

--binary-name

Binary name

--env

Print the update to env variable

--bin-dir

Binary directory

---

setup-ide command

IMPLEMENTATION specific for Scala Runner specification.

Generate a BSP file that you can import into your IDE

MUST have options

--dependency

Add dependencies

Aliases: --dep

--compiler-plugin

Add compiler plugin dependencies

Aliases: -P ,--plugin

--scala-version

Set the Scala version

Aliases: --scala ,-S

--scala-binary-version

Set the Scala binary version

Aliases: --scala-binary ,--scala-bin ,-B

--extra-jars

Add extra JARs and compiled classes to the class path

Aliases: --jar ,--jars ,--extra-jar ,--class ,--extra-class ,--classes ,--extra-classes ,-classpath ,-cp ,--classpath ,--class-path ,--extra-class-path

--resource-dirs

Add a resource directory

Aliases: --resource-dir

--compilation-output

Copy compilation results to output directory using either relative or absolute path

Aliases: --output-directory ,-d ,--destination ,--compile-output ,--compile-out

SHOULD have options

--js

Enable Scala.js. To show more options for Scala.js pass --help-js

--js-version

The Scala.js version

--js-mode

The Scala.js mode, either dev or release

--js-module-kind

The Scala.js module kind: commonjs/common, esmodule/es, nomodule/none

--js-check-ir

--js-emit-source-maps

Emit source maps

--js-source-maps-path

Set the destination path of source maps

--js-dom

Enable jsdom

--js-header

A header that will be added at the top of generated .js files

--js-es-version

The Scala.js ECMA Script version: es5_1, es2015, es2016, es2017, es2018, es2019, es2020, es2021

--native

Enable Scala Native. To show more options for Scala Native pass --help-native

--native-version

Set the Scala Native version

--native-mode

Set Scala Native compilation mode

--native-gc

Set the Scala Native garbage collector

--native-linking

Extra options passed to clang verbatim during linking

--native-compile

List of compile options

--embed-resources

Embed resources into the Scala Native binary (can be read with the Java resources API)

--repository

Add repositories

Aliases: --repo ,-r

--debug

Turn debugging on

--debug-port

Debug port (5005 by default)

--debug-mode

Debug mode (attach by default)

--java-home

Set the Java home directory

--jvm

Use a specific JVM, such as 14, adopt:11, or graalvm:21, or system

Aliases: -j

--javac-plugin

Javac plugin dependencies or files

--javac-option

Javac options

Aliases: --javac-opt

--script-snippet

Allows to execute a passed string as a Scala script

--execute-script

A synonym to --script-snippet, which defaults the sub-command to run when no sub-command is passed explicitly

Aliases: --execute-scala-script ,--execute-sc ,-e

--scala-snippet

Allows to execute a passed string as Scala code

--extra-compile-only-jars

Add extra JARs in the compilaion class path. Mainly using to run code in managed environments like Spark not to include certain depenencies on runtime ClassPath.

Aliases: --compile-only-jar ,--compile-only-jars ,--extra-compile-only-jar

--extra-source-jars

Add extra source JARs

Aliases: --source-jar ,--source-jars ,--extra-source-jar

--platform

Specify platform

--semantic-db

Generate SemanticDBs

Implementantation specific options

--usage

Print usage and exit

--help

Print help message and exit

Aliases: -h ,-help

--help-full

Print help message, including hidden options, and exit

Aliases: --full-help

--verbose

Increase verbosity (can be specified multiple times)

Aliases: -v

--interactive

Interactive mode

Aliases: -i

--actions

Enable actionable diagnostics

--quiet

Decrease verbosity

Aliases: -q

--progress

Use progress bars

--js-allow-big-ints-for-longs

Primitive Longs may be compiled as primitive JavaScript bigints

--js-avoid-classes

Avoid class'es when using functions and prototypes has the same observable semantics.

--js-avoid-lets-and-consts

Avoid lets and consts when using vars has the same observable semantics.

--js-module-split-style

The Scala.js module split style: fewestmodules, smallestmodules, smallmodulesfor

--js-small-module-for-package

Create as many small modules as possible for the classes in the passed packages and their subpackages.

--js-linker-path

Path to the Scala.js linker

--js-cli-version

Scala.js CLI version to use for linking

--js-cli-java-arg

Scala.js CLI Java options

--js-cli-on-jvm

Whether to run the Scala.js CLI on the JVM or using a native executable

--native-clang

Path to the Clang command

--native-clangpp

Path to the Clang++ command

--native-linking-defaults

Use default linking settings

--native-compile-defaults

Use default compile options

--bloop-bsp-protocol

Protocol to use to open a BSP connection with Bloop

--bloop-bsp-socket

Socket file to use to open a BSP connection with Bloop

--bloop-host

Host the compilation server should bind to

--bloop-port

Port the compilation server should bind to (pass -1 to pick a random port)

--bloop-daemon-dir

Daemon directory of the Bloop daemon (directory with lock, pid, and socket files)

--bloop-version

If Bloop isn't already running, the version we should start

--bloop-bsp-timeout

Maximum duration to wait for the BSP connection to be opened

--bloop-bsp-check-period

Duration between checks of the BSP connection state

--bloop-startup-timeout

Maximum duration to wait for the compilation server to start up

--bloop-default-java-opts

Include default JVM options for Bloop

--bloop-java-opt

Pass java options to use by Bloop server

--bloop-global-options-file

Bloop global options file

--bloop-jvm

JVM to use to start Bloop (e.g. 'system|11', 'temurin:17', …)

--bloop-working-dir

Working directory for Bloop, if it needs to be started

--server

Enable / disable usage of Bloop compilation server. Bloop is used by default so use --server:false to disable it. Disabling compilation server allows to test compilation in more controlled mannter (no caching or incremental compiler) but has a detrimental effect of performance.

--home-directory

Override the path to user's home directory

Aliases: --home

--scalac-option

Add a scalac option. Note that options starting with -g, -language, -opt, -P, -target, -V, -W, -X, and -Y are assumed to be Scala compiler options and don't require to be passed after -O or --scalac-option.

Aliases: --scala-opt ,-O ,--scala-option

--jvm-index

JVM index URL

--jvm-index-os

Operating system to use when looking up in the JVM index

--jvm-index-arch

CPU architecture to use when looking up in the JVM index

--bsp-debug-port

Port for BSP debugging

--ttl

Specify a TTL for changing dependencies, such as snapshots

--cache

Set the coursier cache location

--coursier-validate-checksums

Enable checksum validation of artifacts downloaded by coursier

--workspace

Directory where .scala-build is written

--scalac-help

Show help for scalac. This is an alias for --scalac-option -help

Aliases: --help-scalac

--scalac-verbose

Turn verbosity on for scalac. This is an alias for --scalac-option -verbose

Aliases: --verbose-scalac

--execute-scala

A synonym to --scala-snippet, which defaults the sub-command to run when no sub-command is passed explicitly

--java-snippet

Allows to execute a passed string as Java code

--execute-java

A synonym to --scala-snippet, which defaults the sub-command to run when no sub-command is passed explicitly

--scala-library

--java

Do not add dependency to Scala Standard library. This is useful, when Scala CLI works with pure Java projects.

--runner

Should include Scala CLI runner on the runtime ClassPath. Runner is added by default for application running on JVM using standard Scala versions. Runner is used to make stack traces more readable in case of application failure.

--add-stubs

Add dependency for stubs needed to make $ivy and $dep imports to work.

--default-forbidden-directories

--forbid

--help-js

Show options for ScalaJS

--help-native

Show options for ScalaNative

--strict-bloop-json-check

--bsp-directory

Custom BSP configuration location

Aliases: --bsp-dir

--bsp-name

Name of BSP

Aliases: --name

--charset

---

uninstall command

IMPLEMENTATION specific for Scala Runner specification.

Uninstall scala-cli - only works when installed by the installation script

Implementantation specific options

--usage

Print usage and exit

--help

Print help message and exit

Aliases: -h ,-help

--help-full

Print help message, including hidden options, and exit

Aliases: --full-help

--verbose

Increase verbosity (can be specified multiple times)

Aliases: -v

--interactive

Interactive mode

Aliases: -i

--actions

Enable actionable diagnostics

--quiet

Decrease verbosity

Aliases: -q

--progress

Use progress bars

--bloop-bsp-protocol

Protocol to use to open a BSP connection with Bloop

--bloop-bsp-socket

Socket file to use to open a BSP connection with Bloop

--bloop-host

Host the compilation server should bind to

--bloop-port

Port the compilation server should bind to (pass -1 to pick a random port)

--bloop-daemon-dir

Daemon directory of the Bloop daemon (directory with lock, pid, and socket files)

--bloop-version

If Bloop isn't already running, the version we should start

--bloop-bsp-timeout

Maximum duration to wait for the BSP connection to be opened

--bloop-bsp-check-period

Duration between checks of the BSP connection state

--bloop-startup-timeout

Maximum duration to wait for the compilation server to start up

--bloop-default-java-opts

Include default JVM options for Bloop

--bloop-java-opt

Pass java options to use by Bloop server

--bloop-global-options-file

Bloop global options file

--bloop-jvm

JVM to use to start Bloop (e.g. 'system|11', 'temurin:17', …)

--bloop-working-dir

Working directory for Bloop, if it needs to be started

--server

Enable / disable usage of Bloop compilation server. Bloop is used by default so use --server:false to disable it. Disabling compilation server allows to test compilation in more controlled mannter (no caching or incremental compiler) but has a detrimental effect of performance.

--home-directory

Override the path to user's home directory

Aliases: --home

--ttl

Specify a TTL for changing dependencies, such as snapshots

--cache

Set the coursier cache location

--coursier-validate-checksums

Enable checksum validation of artifacts downloaded by coursier

--rc-file

Path to *rc file, defaults to .bashrc or .zshrc depending on shell

--banner

Custom banner in comment placed in rc file

--name

Custom completions name

--force

Force scala-cli uninstall

Aliases: -f

--skip-cache

Don't clear scala-cli cache

--binary-name

Binary name

--bin-dir

Binary directory

---

uninstall-completions command

IMPLEMENTATION specific for Scala Runner specification.

Aliases: uninstall-completions

Uninstalls completions from your shell

Implementantation specific options

--usage

Print usage and exit

--help

Print help message and exit

Aliases: -h ,-help

--help-full

Print help message, including hidden options, and exit

Aliases: --full-help

--rc-file

Path to *rc file, defaults to .bashrc or .zshrc depending on shell

--banner

Custom banner in comment placed in rc file

--name

Custom completions name

--verbose

Increase verbosity (can be specified multiple times)

Aliases: -v

--interactive

Interactive mode

Aliases: -i

--actions

Enable actionable diagnostics

--quiet

Decrease verbosity

Aliases: -q

--progress

Use progress bars

---

update command

IMPLEMENTATION specific for Scala Runner specification.

Update scala-cli - only works when installed by the installation script

Implementantation specific options

--usage

Print usage and exit

--help

Print help message and exit

Aliases: -h ,-help

--help-full

Print help message, including hidden options, and exit

Aliases: --full-help

--verbose

Increase verbosity (can be specified multiple times)

Aliases: -v

--interactive

Interactive mode

Aliases: -i

--actions

Enable actionable diagnostics

--binary-name

Binary name

--bin-dir

Binary directory

--force

Force update scala-cli if is outdated

Aliases: -f

--is-internal-run

--gh-token

A github token used to access GitHub. Not needed in most cases.

---