CLI --help · Bloop

`bloop about`

Usage

--config-dir or -c (type: path?): File path to the bloop config directory, defaults to `.bloop` in the current working directory.
--version or -v (type: bool): If set, print the about section at the beginning of the execution. Defaults to false.
--verbose (type: bool): If set, print out debugging information to stderr. Defaults to false.
--no-color (type: bool): If set, do not color output. Defaults to false.
--debug (type: "all" | "file-watching" | "compilation" | "test" | "bsp" | "link"*): Debug the execution of a concrete task.

`bloop autocomplete`

Usage

--config-dir or -c (type: path?): File path to the bloop config directory, defaults to `.bloop` in the current working directory.
--version or -v (type: bool): If set, print the about section at the beginning of the execution. Defaults to false.
--verbose (type: bool): If set, print out debugging information to stderr. Defaults to false.
--no-color (type: bool): If set, do not color output. Defaults to false.
--debug (type: "all" | "file-watching" | "compilation" | "test" | "bsp" | "link"*): Debug the execution of a concrete task.
--mode (type: mode)
--format (type: "bash" | "zsh" | "fish")
--command (type: string?)
--project (type: string?)

`bloop bsp`

Usage

--protocol (type: protocol): The connection protocol for the bsp server. By default, local.
--host (type: string): The server host for the bsp server (TCP only).
--port (type: int): The port for the bsp server (TCP only).
--socket (type: path?): A path to a socket file to communicate through Unix sockets (local only).
--pipe-name (type: string?): A path to a new existing socket file to communicate through Unix sockets (local only).
--config-dir or -c (type: path?): File path to the bloop config directory, defaults to `.bloop` in the current working directory.
--version or -v (type: bool): If set, print the about section at the beginning of the execution. Defaults to false.
--verbose (type: bool): If set, print out debugging information to stderr. Defaults to false.
--no-color (type: bool): If set, do not color output. Defaults to false.
--debug (type: "all" | "file-watching" | "compilation" | "test" | "bsp" | "link"*): Debug the execution of a concrete task.

`bloop clean`

Usage

--projects or -p or --project (type: string*): The projects to clean (you can specify multiple). If none, all are cleaned.
--include-dependencies or --propagate (type: bool): Clean a project and all its dependencies. By default, false.
--cascade (type: bool): Clean a project and all projects depending on it. By default, false.
--config-dir or -c (type: path?): File path to the bloop config directory, defaults to `.bloop` in the current working directory.
--version or -v (type: bool): If set, print the about section at the beginning of the execution. Defaults to false.
--verbose (type: bool): If set, print out debugging information to stderr. Defaults to false.
--no-color (type: bool): If set, do not color output. Defaults to false.
--debug (type: "all" | "file-watching" | "compilation" | "test" | "bsp" | "link"*): Debug the execution of a concrete task.

Examples

bloop clean
bloop clean foobar
bloop clean foobar baz
bloop clean foobar --propagate

`bloop compile`

Usage

--projects or -p or --project (type: string*): The projects to compile (will be inferred from remaining cli args).
--incremental (type: bool): Compile the project incrementally. By default, true.
--pipeline (type: bool): Pipeline the compilation of modules in your build. By default, false.
--reporter (type: reporter): Pick reporter to show compilation messages. By default, bloop's used.
--watch or -w (type: bool): Run the command when projects' source files change. By default, false.
--cascade (type: bool): Compile a project and all projects depending on it. By default, false.
--config-dir or -c (type: path?): File path to the bloop config directory, defaults to `.bloop` in the current working directory.
--version or -v (type: bool): If set, print the about section at the beginning of the execution. Defaults to false.
--verbose (type: bool): If set, print out debugging information to stderr. Defaults to false.
--no-color (type: bool): If set, do not color output. Defaults to false.
--debug (type: "all" | "file-watching" | "compilation" | "test" | "bsp" | "link"*): Debug the execution of a concrete task.

Examples

bloop compile foobar
bloop compile foobar --cascade
bloop compile foobar baz
bloop compile foobar -w
bloop compile foobar --reporter bloop
bloop compile foobar --reporter scalac

`bloop configure`

Usage

--threads (type: int): (deprecated) Set the number of threads used to compile and test all projects.
--config-dir or -c (type: path?): File path to the bloop config directory, defaults to `.bloop` in the current working directory.
--version or -v (type: bool): If set, print the about section at the beginning of the execution. Defaults to false.
--verbose (type: bool): If set, print out debugging information to stderr. Defaults to false.
--no-color (type: bool): If set, do not color output. Defaults to false.
--debug (type: "all" | "file-watching" | "compilation" | "test" | "bsp" | "link"*): Debug the execution of a concrete task.

`bloop console`

Usage

--projects or -p or --project (type: string*): The projects to run the console at (will be inferred from remaining cli args).
--incremental (type: bool): Compile the project incrementally. By default, true.
--pipeline (type: bool): Pipeline the compilation of modules in your build. By default, false.
--reporter (type: reporter): Pick reporter to show compilation messages. By default, bloop's used.
--exclude-root (type: bool): Start up the console compiling only the target project's dependencies.
--repl (type: repl): Pick REPL to run console. The default is Ammonite, available REPLs are: scalac, ammonite
--args (type: string*): The arguments to pass in to Ammonite.
--ammonite-version (type: string?): The Ammonite version to use, it defaults to latest release. Ammonite REPL only.
--out-file (type: path?): The output file where the Ammonite command is written. Ammonite REPL only.
--config-dir or -c (type: path?): File path to the bloop config directory, defaults to `.bloop` in the current working directory.
--version or -v (type: bool): If set, print the about section at the beginning of the execution. Defaults to false.
--verbose (type: bool): If set, print out debugging information to stderr. Defaults to false.
--no-color (type: bool): If set, do not color output. Defaults to false.
--debug (type: "all" | "file-watching" | "compilation" | "test" | "bsp" | "link"*): Debug the execution of a concrete task.

Examples

bloop console foobar
bloop console foobar --exclude-root

`bloop help`

Usage

--config-dir or -c (type: path?): File path to the bloop config directory, defaults to `.bloop` in the current working directory.
--version or -v (type: bool): If set, print the about section at the beginning of the execution. Defaults to false.
--verbose (type: bool): If set, print out debugging information to stderr. Defaults to false.
--no-color (type: bool): If set, do not color output. Defaults to false.
--debug (type: "all" | "file-watching" | "compilation" | "test" | "bsp" | "link"*): Debug the execution of a concrete task.

`bloop link`

Usage

--projects or --project or -p (type: string*): The projects to link (will be inferred from remaining cli args).
--main or -m (type: string?): The main class to link. Leave unset to let bloop select automatically.
--incremental (type: bool): Compile the project incrementally. By default, true.
--pipeline (type: bool): Pipeline the compilation of modules in your build. By default, false.
--reporter (type: reporter): Pick reporter to show compilation messages. By default, bloop's used.
--watch or -w (type: bool): If set, run the command whenever projects' source files change.
--optimize or -O (type: "debug" | "release"?): Optimization level of the linker. Valid options: `debug` or `release` mode. Defaults to `debug`.
--config-dir or -c (type: path?): File path to the bloop config directory, defaults to `.bloop` in the current working directory.
--version or -v (type: bool): If set, print the about section at the beginning of the execution. Defaults to false.
--verbose (type: bool): If set, print out debugging information to stderr. Defaults to false.
--no-color (type: bool): If set, do not color output. Defaults to false.
--debug (type: "all" | "file-watching" | "compilation" | "test" | "bsp" | "link"*): Debug the execution of a concrete task.

Examples

bloop link foobar
bloop link foobar --main com.acme.Main
bloop link foobar -O debug -w
bloop link foobar -O release -w
bloop link foobar --main com.acme.Main -w

`bloop projects`

Usage

--dot-graph (type: bool): Print out a dot graph you can pipe into `dot`. By default, false.
--config-dir or -c (type: path?): File path to the bloop config directory, defaults to `.bloop` in the current working directory.
--version or -v (type: bool): If set, print the about section at the beginning of the execution. Defaults to false.
--verbose (type: bool): If set, print out debugging information to stderr. Defaults to false.
--no-color (type: bool): If set, do not color output. Defaults to false.
--debug (type: "all" | "file-watching" | "compilation" | "test" | "bsp" | "link"*): Debug the execution of a concrete task.

Examples

bloop projects
bloop projects --dot-graph

`bloop run`

Usage

--projects or -p or --project (type: string*): The projects to run (will be inferred from remaining cli args).
--main or -m (type: string?): The main class to run. Leave unset to let bloop select automatically.
--incremental (type: bool): Compile the project incrementally. By default, true.
--pipeline (type: bool): Pipeline the compilation of modules in your build. By default, false.
--reporter (type: reporter): Pick reporter to show compilation messages. By default, bloop's used.
--args (type: string*): The arguments to pass in to the main class.
--watch or -w (type: bool): If set, run the command whenever projects' source files change.
--skip-jargs (type: bool): Ignore arguments starting with `-J` and forward them instead.
--optimize or -O (type: "debug" | "release"?): If an optimizer is used (e.g. Scala Native or Scala.js), run it in `debug` or `release` mode. Defaults to `debug`.
--config-dir or -c (type: path?): File path to the bloop config directory, defaults to `.bloop` in the current working directory.
--version or -v (type: bool): If set, print the about section at the beginning of the execution. Defaults to false.
--verbose (type: bool): If set, print out debugging information to stderr. Defaults to false.
--no-color (type: bool): If set, do not color output. Defaults to false.
--debug (type: "all" | "file-watching" | "compilation" | "test" | "bsp" | "link"*): Debug the execution of a concrete task.

Examples

bloop run foobar
bloop run foobar -m com.acme.Main -- -J-Xmx4g arg1 arg2
bloop run foobar -O debug -- arg1
bloop run foobar -m com.acme.Main -O release -w

`bloop test`

Usage

--projects or -p or --project (type: string*): The projects to test (will be inferred from remaining cli args).
--include-dependencies or --propagate (type: bool): Test a project and all its dependencies. By default, false.
--cascade (type: bool): Test a project and all projects depending on it. By default, false.
--incremental (type: bool): Compile the project incrementally. By default, true.
--pipeline (type: bool): Pipeline the compilation of modules in your build. By default, false.
--only or -o (type: string*): The list of test suite filters to test for only.
--args (type: string*): The arguments to pass in to the test framework.
--reporter (type: reporter): Pick reporter to show compilation messages. By default, bloop's used.
--watch or -w (type: bool): Run the command when projects' source files change. By default, false.
--config-dir or -c (type: path?): File path to the bloop config directory, defaults to `.bloop` in the current working directory.
--version or -v (type: bool): If set, print the about section at the beginning of the execution. Defaults to false.
--verbose (type: bool): If set, print out debugging information to stderr. Defaults to false.
--no-color (type: bool): If set, do not color output. Defaults to false.
--debug (type: "all" | "file-watching" | "compilation" | "test" | "bsp" | "link"*): Debug the execution of a concrete task.
--parallel (type: bool): Run tests in parallel. Should be chosen at user's discretion. By default, false

Examples

bloop test foobar
bloop test foobar --cascade
bloop test foobar baz
bloop test foobar -w
bloop test foobar --propagate
bloop test foobar --propagate -w
bloop test foobar --only com.acme.StringSpecification
bloop test foobar --only com.acme.StringSpecification -- -J-Xmx4g