| title | sidebar_position |
|---|---|
Commands |
3 |
Clean the workspace.
You are currently viewing the basic help for the clean sub-command. You can view the full help by running: scala-cli clean --help-full For detailed documentation refer to our website: https://scala-cli.virtuslab.org/docs/commands/clean
Accepts option groups: bsp file, logging, verbosity, workspace
Compile Scala code.
You are currently viewing the basic help for the compile sub-command. You can view the full help by running: scala-cli compile --help-full For detailed documentation refer to our website: https://scala-cli.virtuslab.org/docs/commands/compile
Accepts option groups: compilation server, compile, coursier, cross, debug, dependency, help group, input, jvm, logging, markdown, python, Scala.js, Scala Native, scalac, scalac extra, shared, snippet, suppress warning, verbosity, watch, workspace
Configure global settings for Scala CLI.
You are currently viewing the basic help for the config sub-command. You can view the full help by running: scala-cli config --help-full For detailed documentation refer to our website: https://scala-cli.virtuslab.org/docs/commands/misc/config
Accepts option groups: config, coursier, debug, jvm, logging, pgp scala signing, verbosity
Update dependency directives in the project
Accepts option groups: compilation server, coursier, debug, dependency, dependency update, help group, input, jvm, logging, markdown, python, Scala.js, Scala Native, scalac, scalac extra, shared, snippet, suppress warning, verbosity, workspace
Generate Scaladoc documentation.
You are currently viewing the basic help for the doc sub-command. You can view the full help by running: scala-cli doc --help-full For detailed documentation refer to our website: https://scala-cli.virtuslab.org/docs/commands/doc
Accepts option groups: compilation server, coursier, debug, dependency, doc, help group, input, jvm, logging, markdown, python, Scala.js, Scala Native, scalac, scalac extra, shared, snippet, suppress warning, verbosity, workspace
Export current project to an external build tool (like SBT or Mill) or to JSON.
Detailed documentation can be found on our website: https://scala-cli.virtuslab.org
Accepts option groups: compilation server, coursier, debug, dependency, export, help group, input, jvm, logging, main class, markdown, python, Scala.js, Scala Native, scalac, scalac extra, shared, snippet, suppress warning, verbosity, workspace
Aliases: format, scalafmt
Formats Scala code.
You are currently viewing the basic help for the fmt sub-command. You can view the full help by running: scala-cli fmt --help-full For detailed documentation refer to our website: https://scala-cli.virtuslab.org/docs/commands/fmt
Accepts option groups: compilation server, coursier, debug, dependency, fmt, help group, input, jvm, logging, markdown, python, Scala.js, Scala Native, scalac, scalac extra, shared, snippet, suppress warning, verbosity, workspace
Print help message
Accepts option groups: logging, verbosity
Aliases: install-completions
Installs Scala CLI completions into your shell
You are currently viewing the basic help for the install completions sub-command. You can view the full help by running: scala-cli install completions --help-full For detailed documentation refer to our website: https://scala-cli.virtuslab.org/docs/commands/completions
Accepts option groups: install completions, logging, verbosity
Aliases: console
Fire-up a Scala REPL.
You are currently viewing the basic help for the repl sub-command. You can view the full help by running: scala-cli repl --help-full For detailed documentation refer to our website: https://scala-cli.virtuslab.org/docs/commands/repl
Accepts option groups: compilation server, coursier, cross, debug, dependency, 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
Compile and package Scala code.
You are currently viewing the basic help for the package sub-command. You can view the full help by running: scala-cli --power package --help-full For detailed documentation refer to our website: https://scala-cli.virtuslab.org/docs/commands/package
Accepts option groups: compilation server, coursier, cross, debug, dependency, 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
Publishes build artifacts to Maven repositories.
You are currently viewing the basic help for the publish sub-command. You can view the full help by running: scala-cli --power publish --help-full For detailed documentation refer to our website: https://scala-cli.virtuslab.org/docs/commands/publishing/publish
Accepts option groups: compilation server, coursier, cross, debug, dependency, 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
Publishes build artifacts to the local Ivy2 repository.
You are currently viewing the basic help for the publish local sub-command. You can view the full help by running: scala-cli publish local --help-full For detailed documentation refer to our website: https://scala-cli.virtuslab.org/docs/commands/publishing/publish-local
Accepts option groups: compilation server, coursier, cross, debug, dependency, 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
Configures the project for publishing.
You are currently viewing the basic help for the publish setup sub-command. You can view the full help by running: scala-cli publish setup --help-full For detailed documentation refer to our website: https://scala-cli.virtuslab.org/docs/commands/publishing/publish-setup
Accepts option groups: coursier, debug, input, jvm, logging, pgp push pull, pgp scala signing, publish params, publish repository, publish setup, verbosity, workspace
Compile and run Scala code.
You are currently viewing the basic help for the run sub-command. You can view the full help by running: scala-cli run --help-full For detailed documentation refer to our website: https://scala-cli.virtuslab.org/docs/commands/run
Accepts option groups: benchmarking, compilation server, coursier, cross, debug, dependency, 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
Aliases: gh secret create
Creates or updates a GitHub repository secret. scala-cli --power github secret create --repo repo-org/repo-name SECRET_VALUE=value:secret
Accepts option groups: coursier, logging, secret, secret create, verbosity
Aliases: gh secret list
Lists secrets for a given GitHub repository.
Accepts option groups: logging, secret, verbosity
Generates a BSP file that you can import into your IDE.
You are currently viewing the basic help for the setup-ide sub-command. You can view the full help by running: scala-cli setup-ide --help-full For detailed documentation refer to our website: https://scala-cli.virtuslab.org/docs/commands/setup-ide
Accepts option groups: bsp file, compilation server, coursier, debug, dependency, help group, input, jvm, logging, markdown, python, Scala.js, Scala Native, scalac, scalac extra, setup IDE, shared, snippet, suppress warning, verbosity, workspace
Like run, but handier for shebang scripts.
You are currently viewing the basic help for the shebang sub-command. You can view the full help by running: scala-cli shebang --help-full For detailed documentation refer to our website: https://scala-cli.virtuslab.org/docs/commands/shebang
Accepts option groups: benchmarking, compilation server, coursier, cross, debug, dependency, 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
Compile and test Scala code.
You are currently viewing the basic help for the test sub-command. You can view the full help by running: scala-cli test --help-full For detailed documentation refer to our website: https://scala-cli.virtuslab.org/docs/commands/test
Accepts option groups: compilation server, coursier, cross, debug, dependency, 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
Uninstalls Scala CLI. Works only when installed with the installation script. For detailed installation instructions refer to our website: https://scala-cli.virtuslab.org/install
Accepts option groups: compilation server, coursier, logging, uninstall, uninstall completions, verbosity
Aliases: uninstall-completions
Uninstalls Scala CLI completions from your shell.
You are currently viewing the basic help for the uninstall completions sub-command. You can view the full help by running: scala-cli uninstall completions --help-full For detailed documentation refer to our website: https://scala-cli.virtuslab.org/docs/commands/completions
Accepts option groups: logging, uninstall completions, verbosity
Updates Scala CLI. Works only when installed with the installation script. If Scala CLI was installed with an external tool, refer to its update methods.
You are currently viewing the basic help for the update sub-command. You can view the full help by running: scala-cli update --help-full For detailed installation instructions refer to our website: https://scala-cli.virtuslab.org/install
Accepts option groups: logging, update, verbosity
Prints the version of the Scala CLI and the default version of Scala.
You are currently viewing the basic help for the version sub-command. You can view the full help by running: scala-cli version --help-full For detailed documentation refer to our website: https://scala-cli.virtuslab.org/docs/commands/version
Accepts option groups: logging, verbosity, version
Hidden commands
Add entries to the PATH environment variable.
Accepts option groups: add path, logging, verbosity
Interact with Bloop (the build server) or check its status.
Accepts option groups: bloop, compilation server, coursier, debug, jvm, logging, verbosity
Stop Bloop if an instance is running.
Bloop is the build server used by Scala CLI. For more information about Bloop, refer to https://scalacenter.github.io/bloop/
Accepts option groups: compilation server, coursier, logging, verbosity
Print Bloop output.
Bloop is the build server used by Scala CLI. For more information about Bloop, refer to https://scalacenter.github.io/bloop/
Accepts option groups: compilation server, logging, verbosity
Starts a Bloop instance, if none is running.
Bloop is the build server used by Scala CLI. For more information about Bloop, refer to https://scalacenter.github.io/bloop/
Accepts option groups: bloop start, compilation server, coursier, debug, jvm, logging, verbosity
Start BSP server.
You are currently viewing the basic help for the bsp sub-command. You can view the full help by running: scala-cli bsp --help-full Detailed documentation can be found on our website: https://scala-cli.virtuslab.org
Accepts option groups: bsp, compilation server, coursier, debug, dependency, help group, input, jvm, logging, markdown, python, Scala.js, Scala Native, scalac, scalac extra, shared, snippet, suppress warning, verbosity, workspace
Generates default files for a Scala CLI project (i.e. .gitignore).
For detailed documentation refer to our website: https://scala-cli.virtuslab.org/docs/commands/misc/default-file
Accepts option groups: default file, logging, verbosity
Prints directories used by Scala CLI.
Accepts option groups: logging, verbosity
Install Scala CLI in a sub-directory of the home directory
Accepts option groups: install home, logging, verbosity
Accepts option groups: logging, pgp pull, pgp push pull, verbosity
Accepts option groups: coursier, debug, jvm, logging, pgp push, pgp push pull, pgp scala signing, verbosity
Create PGP key pair
Accepts option groups: pgp create
Accepts option groups: pgp key id
Sign files with PGP
Accepts option groups: pgp sign
Verify PGP signatures
Accepts option groups: pgp verify