title	sidebar_position
Commands	3

clean

Clean the workspace

Accepts option groups: bsp file, directories, logging, verbosity, workspace

compile

Compile Scala code

Accepts option groups: compilation server, compile, coursier, cross, debug, dependency, directories, help group, input, jvm, logging, markdown, python, Scala.js, Scala Native, scalac, scalac extra, shared, snippet, suppress warning, verbosity, watch, workspace

dependency-update

Update dependencies in project

Accepts option groups: compilation server, coursier, debug, dependency, dependency update, directories, help group, input, jvm, logging, markdown, python, Scala.js, Scala Native, scalac, scalac extra, shared, snippet, suppress warning, verbosity, workspace

doc

Generate Scaladoc documentation

Accepts option groups: compilation server, coursier, debug, dependency, directories, doc, help group, input, jvm, logging, markdown, python, Scala.js, Scala Native, scalac, scalac extra, shared, snippet, suppress warning, verbosity, workspace

export

Export current project to sbt or Mill

Accepts option groups: compilation server, coursier, debug, dependency, directories, export, help group, input, jvm, logging, main class, markdown, python, Scala.js, Scala Native, scalac, scalac extra, shared, snippet, suppress warning, verbosity, workspace

fmt

Aliases: format, scalafmt

Format Scala code

Accepts option groups: compilation server, coursier, debug, dependency, directories, fmt, help group, input, jvm, logging, markdown, python, Scala.js, Scala Native, scalac, scalac extra, shared, snippet, suppress warning, verbosity, workspace

help

Print help message

Accepts option groups: logging, verbosity

install completions

Aliases: install-completions

Installs completions into your shell

Accepts option groups: directories, install completions, logging, verbosity

repl

Aliases: console

Fire-up a Scala REPL

Accepts option groups: compilation server, coursier, cross, debug, dependency, directories, help group, input, java, java prop, jvm, logging, markdown, python, repl, Scala.js, Scala Native, scalac, scalac extra, shared, snippet, suppress warning, verbosity, watch, workspace

package

Compile and package Scala code

Accepts option groups: compilation server, coursier, cross, debug, dependency, directories, help group, input, java, java prop, jvm, logging, main class, markdown, package, packager, python, Scala.js, Scala Native, scalac, scalac extra, shared, snippet, suppress warning, verbosity, watch, workspace

publish

Accepts option groups: compilation server, coursier, cross, debug, dependency, directories, help group, input, jvm, logging, main class, markdown, pgp scala signing, publish, publish params, publish repository, python, Scala.js, Scala Native, scalac, scalac extra, shared, snippet, suppress warning, verbosity, watch, workspace

publish local

Accepts option groups: compilation server, coursier, cross, debug, dependency, directories, help group, input, jvm, logging, main class, markdown, pgp scala signing, publish, publish params, python, Scala.js, Scala Native, scalac, scalac extra, shared, snippet, suppress warning, verbosity, watch, workspace

publish setup

Accepts option groups: coursier, debug, directories, input, jvm, logging, pgp push pull, pgp scala signing, publish params, publish repository, publish setup, verbosity, workspace

run

Compile and run Scala code.

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

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

Accepts option groups: benchmarking, compilation server, coursier, cross, debug, dependency, directories, help group, input, java, java prop, jvm, logging, main class, markdown, python, run, Scala.js, Scala Native, scalac, scalac extra, shared, snippet, suppress warning, verbosity, watch, workspace

github secret create

Aliases: gh secret create

Accepts option groups: coursier, logging, secret, secret create, verbosity

github secret list

Aliases: gh secret list

Accepts option groups: logging, secret, verbosity

setup-ide

Generate a BSP file that you can import into your IDE

Accepts option groups: bsp file, compilation server, coursier, debug, dependency, directories, help group, input, jvm, logging, markdown, python, Scala.js, Scala Native, scalac, scalac extra, setup IDE, shared, snippet, suppress warning, verbosity, workspace

shebang

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. And program arguments 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)

Accepts option groups: benchmarking, compilation server, coursier, cross, debug, dependency, directories, help group, input, java, java prop, jvm, logging, main class, markdown, python, run, Scala.js, Scala Native, scalac, scalac extra, shared, snippet, suppress warning, verbosity, watch, workspace

test

Compile and test Scala code

Accepts option groups: compilation server, coursier, cross, debug, dependency, directories, help group, input, java, java prop, jvm, logging, markdown, python, Scala.js, Scala Native, scalac, scalac extra, shared, snippet, suppress warning, test, verbosity, watch, workspace

uninstall

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

Accepts option groups: compilation server, coursier, directories, logging, uninstall, uninstall completions, verbosity

uninstall completions

Aliases: uninstall-completions

Uninstalls completions from your shell

Accepts option groups: logging, uninstall completions, verbosity

update

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

Accepts option groups: logging, update, verbosity

version

Print the version of the scala runner and the default version of Scala (unless specified in the project).

The version of the scala runner is the version of the command-line tool that runs Scala programs, which is distinct from the Scala version of a program. We recommend you specify the version of Scala of a program in the program itself (via a configuration directive). Otherwise, the runner falls back to the default Scala version defined by the runner.

Accepts option groups: logging, verbosity, version

Hidden commands

add-path

Accepts option groups: add path, logging, verbosity

bsp

Start BSP server

Accepts option groups: bsp, compilation server, coursier, debug, dependency, directories, help group, input, jvm, logging, markdown, python, Scala.js, Scala Native, scalac, scalac extra, shared, snippet, suppress warning, verbosity, workspace

config

Accepts option groups: config, coursier, debug, directories, jvm, logging, pgp scala signing, verbosity

default-file

Accepts option groups: default file, logging, verbosity

directories

Prints directories used by Scala CLI

Accepts option groups: directories, logging, verbosity

install-home

Install Scala CLI in a sub-directory of the home directory

Accepts option groups: install home, logging, verbosity

browse

Aliases: metabrowse

Browse Scala code and its dependencies in the browser

Accepts option groups: compilation server, coursier, debug, dependency, directories, help group, input, jvm, logging, markdown, metabrowse, python, Scala.js, Scala Native, scalac, scalac extra, shared, snippet, suppress warning, verbosity, workspace

pgp pull

Accepts option groups: logging, pgp pull, pgp push pull, verbosity

pgp push

Accepts option groups: coursier, debug, jvm, logging, pgp push, pgp push pull, pgp scala signing, verbosity

pgp create

Create PGP key pair

Accepts option groups: pgp create

pgp key-id

Accepts option groups: pgp key id

pgp sign

Sign files with PGP

Accepts option groups: pgp sign

pgp verify

Verify PGP signatures

Accepts option groups: pgp verify

Files

commands.md

Latest commit

History