Type Members

1.  final case class AboutOptions(verbosity: VerbosityOptions = VerbosityOptions(), ghToken: Option[PasswordOption] = None) extends Product with Serializable

   Annotations

   @HelpMessage("Print details about this application", caseapp.this.HelpMessage.<init>$default$2)

2.  final case class AddPathOptions(verbosityOptions: VerbosityOptions = VerbosityOptions(), quiet: Boolean = false, title: String = "") extends Product with Serializable
3.  final case class BenchmarkingOptions(jmh: Option[Boolean] = None, jmhVersion: Option[String] = None) extends Product with Serializable
4.  final case class BloopExitOptions(logging: LoggingOptions = LoggingOptions(), compilationServer: SharedCompilationServerOptions = SharedCompilationServerOptions(), directories: SharedDirectoriesOptions = SharedDirectoriesOptions(), coursier: CoursierOptions = CoursierOptions()) extends Product with Serializable
5.  final case class BloopStartOptions(logging: LoggingOptions = LoggingOptions(), compilationServer: SharedCompilationServerOptions = SharedCompilationServerOptions(), directories: SharedDirectoriesOptions = SharedDirectoriesOptions(), jvm: SharedJvmOptions = SharedJvmOptions(), coursier: CoursierOptions = CoursierOptions(), force: Boolean = false) extends Product with Serializable
6.  final case class BspOptions(shared: SharedOptions = SharedOptions(), jsonOptions: Option[String] = None) extends Product with Serializable

   Annotations

   @HelpMessage("Start BSP server", caseapp.this.HelpMessage.<init>$default$2)

7.  final case class CleanOptions(logging: LoggingOptions = LoggingOptions(), directories: SharedDirectoriesOptions = SharedDirectoriesOptions(), bspFile: SharedBspFileOptions = SharedBspFileOptions(), workspace: SharedWorkspaceOptions = SharedWorkspaceOptions()) extends Product with Serializable

   Annotations

   @HelpMessage("Clean the workspace", caseapp.this.HelpMessage.<init>$default$2)

8.  final case class CompileOptions(shared: SharedOptions = SharedOptions(), watch: SharedWatchOptions = SharedWatchOptions(), cross: CrossOptions = CrossOptions(), classPath: Boolean = false, output: Option[String] = None, test: Boolean = false) extends Product with Serializable

   Annotations

   @HelpMessage("Compile Scala code", caseapp.this.HelpMessage.<init>$default$2)

9.  final case class CoursierOptions(ttl: Option[String] = None, cache: Option[String] = None, coursierValidateChecksums: Option[Boolean] = None) extends Product with Serializable
10.  final case class CrossOptions(cross: Option[Boolean] = None) extends Product with Serializable
11.  case class DefaultOptions(shared: SharedOptions = SharedOptions(), sharedRun: SharedRunOptions = SharedRunOptions(), sharedRepl: SharedReplOptions = SharedReplOptions(), version: Boolean = false) extends Product with Serializable
12.  final case class DependencyUpdateOptions(shared: SharedOptions = SharedOptions(), all: Boolean = false) extends Product with Serializable

    Annotations

    @HelpMessage("Update dependencies in project", caseapp.this.HelpMessage.<init>$default$2)

13.  final case class DirectoriesOptions(directories: SharedDirectoriesOptions = SharedDirectoriesOptions(), verbosity: VerbosityOptions = VerbosityOptions()) extends Product with Serializable

    Annotations

    @HelpMessage("Prints directories used by `scala-cli`", caseapp.this.HelpMessage.<init>$default$2)

14.  final case class DocOptions(shared: SharedOptions = SharedOptions(), output: Option[String] = None, force: Boolean = false, defaultScaladocOptions: Option[Boolean] = None) extends Product with Serializable

    Annotations

    @HelpMessage("Generate Scaladoc documentation", "By default, Scala CLI sets common scaladoc options and this mechanism can be disabled by using `--default-scaladoc-opts:false`.")

15.  final case class DoctorOptions(verbosity: VerbosityOptions = VerbosityOptions(), ghToken: Option[PasswordOption] = None) extends Product with Serializable

    Annotations

    @HelpMessage("Print details about this application", caseapp.this.HelpMessage.<init>$default$2)

16.  final case class ExportOptions(shared: SharedOptions = SharedOptions(), mainClass: MainClassOptions = MainClassOptions(), sbt: Option[Boolean] = None, mill: Option[Boolean] = None, sbtSetting: List[String] = Nil, sbtVersion: Option[String] = None, output: Option[String] = None) extends Product with Serializable

    Annotations

    @HelpMessage("Export current project to sbt or Mill", caseapp.this.HelpMessage.<init>$default$2)

17.  final case class FmtOptions(shared: SharedOptions = SharedOptions(), check: Boolean = false, respectProjectFilters: Boolean = true, saveScalafmtConf: Boolean = false, scalafmtHelp: Boolean = false, osArchSuffix: Option[String] = None, scalafmtTag: Option[String] = None, scalafmtGithubOrgName: Option[String] = None, scalafmtExtension: Option[String] = None, scalafmtLauncher: Option[String] = None, scalafmtArg: List[String] = Nil, scalafmtConf: Option[String] = None, scalafmtConfStr: Option[String] = None, scalafmtDialect: Option[String] = None, scalafmtVersion: Option[String] = None) extends Product with Serializable

    Annotations

    @HelpMessage("Format Scala code", caseapp.this.HelpMessage.<init>$default$2)

18.  case class HelpGroupOptions(helpJs: Boolean = false, helpNative: Boolean = false) extends Product with Serializable

    Annotations

    @HelpMessage("Print help message", caseapp.this.HelpMessage.<init>$default$2)

19.  case class HelpOptions() extends Product with Serializable

    Annotations

    @HelpMessage("Print help message", caseapp.this.HelpMessage.<init>$default$2)

20.  final case class InstallCompletionsOptions(logging: LoggingOptions = LoggingOptions(), directories: SharedDirectoriesOptions = SharedDirectoriesOptions(), format: Option[String] = None, rcFile: Option[String] = None, output: Option[String] = None, banner: String = "{NAME} completions", name: Option[String] = None, env: Boolean = false) extends Product with Serializable

    Annotations

    @HelpMessage("Installs completions into your shell", caseapp.this.HelpMessage.<init>$default$2)

21.  final case class InstallHomeOptions(verbosity: VerbosityOptions = VerbosityOptions(), scalaCliBinaryPath: String, force: Boolean = false, binaryName: String = "scala-cli", env: Boolean = false, binDir: Option[String] = None) extends Product with Serializable

    Annotations

    @HelpMessage("Install `scala-cli` in a sub-directory of the home directory", caseapp.this.HelpMessage.<init>$default$2)

22.  final case class LoggingOptions(verbosityOptions: VerbosityOptions = VerbosityOptions(), quiet: Boolean = false, progress: Option[Boolean] = None) extends Product with Serializable
23.  final case class MainClassOptions(mainClass: Option[String] = None, mainClassLs: Option[Boolean] = None) extends Product with Serializable
24.  final case class MarkdownOptions(enableMarkdown: Boolean = false) extends Product with Serializable
25.  final case class MetabrowseOptions(shared: SharedOptions = SharedOptions(), addRtJar: Option[Boolean] = None, host: String = "localhost", port: Int = 4000, osArchSuffix: Option[String] = None, metabrowseTag: Option[String] = None, metabrowseGithubOrgName: Option[String] = None, metabrowseExtension: Option[String] = None, metabrowseLauncher: Option[String] = None, metabrowseDialect: Option[String] = None) extends Product with Serializable

    Annotations

    @HelpMessage("Browse Scala code and its dependencies in the browser", caseapp.this.HelpMessage.<init>$default$2)

26.  final case class PackageOptions(shared: SharedOptions = SharedOptions(), watch: SharedWatchOptions = SharedWatchOptions(), java: SharedJavaOptions = SharedJavaOptions(), compileCross: CrossOptions = CrossOptions(), mainClass: MainClassOptions = MainClassOptions(), output: Option[String] = None, force: Boolean = false, library: Boolean = false, source: Boolean = false, doc: Boolean = false, assembly: Boolean = false, preamble: Boolean = true, mainClassInManifest: Option[Boolean] = None, spark: Boolean = false, standalone: Option[Boolean] = None, packager: PackagerOptions = PackagerOptions(), deb: Boolean = false, dmg: Boolean = false, rpm: Boolean = false, msi: Boolean = false, pkg: Boolean = false, docker: Boolean = false, provided: List[String] = Nil, defaultScaladocOptions: Option[Boolean] = None, nativeImage: Boolean = false) extends Product with Serializable

    Annotations

    @HelpMessage("Compile and package Scala code", caseapp.this.HelpMessage.<init>$default$2)

27.  final case class PackagerOptions(version: String = "1.0.0", logoPath: Option[String] = None, launcherApp: Option[String] = None, description: Option[String] = None, maintainer: Option[String] = None, debianConflicts: List[String] = Nil, debianDependencies: List[String] = Nil, debArchitecture: String = "all", priority: Option[String] = None, section: Option[String] = None, identifier: Option[String] = None, license: Option[String] = None, release: String = "1", rpmArchitecture: String = "noarch", licensePath: Option[String] = None, productName: String = "Scala packager", exitDialog: Option[String] = None, suppressValidation: Option[Boolean] = None, extraConfig: List[String] = Nil, is64Bits: Boolean = true, installerVersion: Option[String] = None, dockerFrom: Option[String] = None, dockerImageRegistry: Option[String] = None, dockerImageRepository: Option[String] = None, dockerImageTag: Option[String] = None, graalvmJavaVersion: Option[Int] = None, graalvmVersion: Option[String] = None, graalvmJvmId: Option[String] = None) extends Product with Serializable
28.  final case class ReplOptions(shared: SharedOptions = SharedOptions(), sharedRepl: SharedReplOptions = SharedReplOptions()) extends Product with Serializable

    Annotations

    @HelpMessage("Fire-up a Scala REPL", caseapp.this.HelpMessage.<init>$default$2)

29.  final case class RunOptions(shared: SharedOptions = SharedOptions(), sharedRun: SharedRunOptions = SharedRunOptions()) extends Product with Serializable

    Annotations

    @HelpMessage(scala.Predef.augmentString("|Compile and run Scala code.\n |\n |To pass arguments to the application, just add them after `--`, like:\n |\n |```sh\n |scala-cli MyApp.scala -- first-arg second-arg\n |```").stripMargin, caseapp.this.HelpMessage.<init>$default$2)

30.  final case class ScalaJsOptions(js: Boolean = false, jsVersion: Option[String] = None, jsMode: Option[String] = None, jsModuleKind: Option[String] = None, jsCheckIr: Option[Boolean] = None, jsEmitSourceMaps: Boolean = false, jsSourceMapsPath: Option[String] = None, jsDom: Option[Boolean] = None, jsHeader: Option[String] = None, jsAllowBigIntsForLongs: Option[Boolean] = None, jsAvoidClasses: Option[Boolean] = None, jsAvoidLetsAndConsts: Option[Boolean] = None, jsModuleSplitStyle: Option[String] = None, jsSmallModuleForPackage: List[String] = Nil, jsEsVersion: Option[String] = None, jsLinkerPath: Option[String] = None, jsCliVersion: Option[String] = None, jsCliJavaArg: List[String] = Nil, jsCliOnJvm: Option[Boolean] = None) extends Product with Serializable
31.  final case class ScalaNativeOptions(native: Boolean = false, nativeVersion: Option[String] = None, nativeMode: Option[String] = None, nativeGc: Option[String] = None, nativeClang: Option[String] = None, nativeClangpp: Option[String] = None, nativeLinking: List[String] = Nil, nativeLinkingDefaults: Option[Boolean] = None, nativeCompile: List[String] = Nil, nativeCompileDefaults: Option[Boolean] = None, embedResources: Option[Boolean] = None) extends Product with Serializable
32.  final case class ScalacOptions(scalacOption: List[String] = Nil) extends Product with Serializable
33.  final case class SetupIdeOptions(shared: SharedOptions = SharedOptions(), bspFile: SharedBspFileOptions = SharedBspFileOptions(), charset: Option[String] = None) extends Product with Serializable

    Annotations

    @HelpMessage("Generate a BSP file that you can import into your IDE", caseapp.this.HelpMessage.<init>$default$2)

34.  final case class SharedBspFileOptions(bspDirectory: Option[String] = None, bspName: Option[String] = None) extends Product with Serializable
35.  final case class SharedCompilationServerOptions(bloopBspProtocol: Option[String] = None, bloopBspSocket: Option[String] = None, bloopHost: Option[String] = None, bloopPort: Option[Int] = None, bloopDaemonDir: Option[String] = None, bloopVersion: Option[String] = None, bloopBspTimeout: Option[String] = None, bloopBspCheckPeriod: Option[String] = None, bloopStartupTimeout: Option[String] = None, bloopDefaultJavaOpts: Boolean = true, bloopJavaOpt: List[String] = Nil, bloopGlobalOptionsFile: Option[String] = None, bloopJvm: Option[String] = None, bloopWorkingDir: Option[String] = None, server: Option[Boolean] = None) extends Product with Serializable
36.  final case class SharedDependencyOptions(dependency: List[String] = Nil, repository: List[String] = Nil, compilerPlugin: List[String] = Nil) extends Product with Serializable
37.  final case class SharedDirectoriesOptions(homeDirectory: Option[String] = None) extends Product with Serializable
38.  final case class SharedInputOptions(defaultForbiddenDirectories: Boolean = true, forbid: List[String] = Nil) extends Product with Serializable
39.  final case class SharedJavaOptions(javaOpt: List[String] = Nil, javaProp: List[String] = Nil) extends Product with Serializable
40.  final case class SharedJvmOptions(javaHome: Option[String] = None, jvm: Option[String] = None, jvmIndex: Option[String] = None, jvmIndexOs: Option[String] = None, jvmIndexArch: Option[String] = None, javacPlugin: List[String] = Nil, javacOption: List[String] = Nil, bspDebugPort: Option[String] = None) extends Product with Serializable
41.  final case class SharedOptions(logging: LoggingOptions = LoggingOptions(), js: ScalaJsOptions = ScalaJsOptions(), native: ScalaNativeOptions = ScalaNativeOptions(), compilationServer: SharedCompilationServerOptions = SharedCompilationServerOptions(), directories: SharedDirectoriesOptions = SharedDirectoriesOptions(), dependencies: SharedDependencyOptions = SharedDependencyOptions(), scalac: ScalacOptions = ScalacOptions(), jvm: SharedJvmOptions = SharedJvmOptions(), coursier: CoursierOptions = CoursierOptions(), workspace: SharedWorkspaceOptions = SharedWorkspaceOptions(), scalaVersion: Option[String] = None, scalaBinaryVersion: Option[String] = None, scalacHelp: Boolean = false, snippet: SnippetOptions = SnippetOptions(), markdown: MarkdownOptions = MarkdownOptions(), extraJars: List[String] = Nil, extraCompileOnlyJars: List[String] = Nil, extraSourceJars: List[String] = Nil, resourceDirs: List[String] = Nil, scalaLibrary: Option[Boolean] = None, java: Option[Boolean] = None, runner: Option[Boolean] = None, semanticDb: Option[Boolean] = None, addStubs: Option[Boolean] = None, input: SharedInputOptions = SharedInputOptions(), helpGroups: HelpGroupOptions = HelpGroupOptions(), strictBloopJsonCheck: Option[Boolean] = None) extends Product with Serializable
42.  final case class SharedPythonOptions(pythonSetup: Option[Boolean] = None, python: Option[Boolean] = None) extends Product with Serializable
43.  final case class SharedReplOptions(sharedJava: SharedJavaOptions = SharedJavaOptions(), watch: SharedWatchOptions = SharedWatchOptions(), compileCross: CrossOptions = CrossOptions(), ammonite: Option[Boolean] = None, ammoniteVersion: Option[String] = None, ammoniteArg: List[String] = Nil, replDryRun: Boolean = false) extends Product with Serializable
44.  final case class SharedRunOptions(benchmarking: BenchmarkingOptions = BenchmarkingOptions(), sharedJava: SharedJavaOptions = SharedJavaOptions(), watch: SharedWatchOptions = SharedWatchOptions(), compileCross: CrossOptions = CrossOptions(), mainClass: MainClassOptions = MainClassOptions(), sharedPython: SharedPythonOptions = SharedPythonOptions(), sparkSubmit: Option[Boolean] = None, standaloneSpark: Option[Boolean] = None, hadoopJar: Boolean = false, command: Boolean = false, scratchDir: Option[String] = None, useManifest: Option[Boolean] = None) extends Product with Serializable
45.  final case class SharedUninstallCompletionsOptions(rcFile: Option[String] = None, banner: String = "{NAME} completions", name: Option[String] = None) extends Product with Serializable
46.  final case class SharedWatchOptions(watch: Boolean = false, restart: Boolean = false) extends Product with Serializable
47.  final case class SharedWorkspaceOptions(workspace: Option[String] = None) extends Product with Serializable
48.  final case class ShebangOptions(runOptions: RunOptions = RunOptions()) extends Product with Serializable

    Annotations

    @HelpMessage(scala.Predef.augmentString("|Like `run`, but more handy from shebang scripts\n |\n |This command is equivalent to `run`, but it changes the way\n |`scala-cli` parses its command-line arguments in order to be compatible\n |with shebang scripts.\n |\n |Normally, inputs and scala-cli options can be mixed. Program have to be specified after `--`\n |\n |```sh\n |scala-cli [command] [scala_cli_options | input]... -- [program_arguments]...\n |```\n |\n |Contrary, for shebang command, only a single input file can be set, all scala-cli options\n |have to be set before the input file, and program arguments after the input file\n |```sh\n |scala-cli shebang [scala_cli_options]... input [program_arguments]...\n |```\n |\n |Using this, it is possible to conveniently set up Unix shebang scripts. For example:\n |```sh\n |#!/usr/bin/env -S scala-cli shebang --scala-version 2.13\n |println(\"Hello, world)\n |```\n |\n |").stripMargin, caseapp.this.HelpMessage.<init>$default$2)

49.  final case class SnippetOptions(scriptSnippet: List[String] = List.empty, executeScript: List[String] = List.empty, scalaSnippet: List[String] = List.empty, executeScala: List[String] = List.empty, javaSnippet: List[String] = List.empty, executeJava: List[String] = List.empty) extends Product with Serializable
50.  final case class TestOptions(shared: SharedOptions = SharedOptions(), sharedJava: SharedJavaOptions = SharedJavaOptions(), watch: SharedWatchOptions = SharedWatchOptions(), compileCross: CrossOptions = CrossOptions(), testFramework: Option[String] = None, requireTests: Boolean = false) extends Product with Serializable

    Annotations

    @HelpMessage("Compile and test Scala code", caseapp.this.HelpMessage.<init>$default$2)

51.  final case class UninstallCompletionsOptions(shared: SharedUninstallCompletionsOptions = SharedUninstallCompletionsOptions(), logging: LoggingOptions = LoggingOptions()) extends Product with Serializable

    Annotations

    @HelpMessage("Uninstalls completions from your shell", caseapp.this.HelpMessage.<init>$default$2)

52.  final case class UninstallOptions(bloopExit: BloopExitOptions = BloopExitOptions(), sharedUninstallCompletions: SharedUninstallCompletionsOptions = SharedUninstallCompletionsOptions(), force: Boolean = false, skipCache: Boolean = false, binaryName: String = "scala-cli", binDir: Option[String] = None) extends Product with Serializable

    Annotations

    @HelpMessage("Uninstall scala-cli - only works when installed by the installation script", caseapp.this.HelpMessage.<init>$default$2)

53.  final case class UpdateOptions(verbosity: VerbosityOptions = VerbosityOptions(), binaryName: String = "scala-cli", binDir: Option[String] = None, force: Boolean = false, isInternalRun: Boolean = false, ghToken: Option[PasswordOption] = None) extends Product with Serializable

    Annotations

    @HelpMessage("Update scala-cli - only works when installed by the installation script", caseapp.this.HelpMessage.<init>$default$2)

54.  final case class VerbosityOptions(verbose: @@[Int, Counter] = Tag.of(0), interactive: Option[Boolean] = None, actions: Option[Boolean] = None) extends Product with Serializable
55.  final case class VersionOptions(verbosity: VerbosityOptions = VerbosityOptions(), cliVersion: Boolean = false, scalaVersion: Boolean = false) extends Product with Serializable

    Annotations

    @HelpMessage("Print `scala-cli` version", caseapp.this.HelpMessage.<init>$default$2)