Edit

tools/universal/usage

The installation script installs the build server and the bloop command-line application (CLI). The build server will be started first time the command-line application is used.

Verify your installation by running the command-line application:

$ bloop about
bloop v2.0.19

Using Scala v2.12.21 and Zinc v1.12.0
Running on Java JDK v25.0.1 (/Users/tgodzik/.sdkman/candidates/java/25.0.1-tem)
  -> Supports debugging user code, Java Debug Interface (JDI) is available.
Maintained by the Scala Center and the community.

Command-Line Completions

Bloop supports command-line completions in bash, zsh and fish. The use of command-line autocompletions is recommended as it significantly improves the user experience. The installation of autocompletions via curl requires you to configure the completions manually.

Note that the following instructions assume that the bloop installation directory is the default $HOME/.bloop.

Zsh Completions

Add the following to your ~/.zshrc:

autoload -U compinit
fpath=($HOME/.bloop/zsh $fpath)
compinit

Bash Completions

Add the following to your ~/.bash_profile:

. $HOME/.bloop/bash/bloop

Fish Completions

Symlink the fish completions file in the Bloop installation directory to your local fish completions directory (usually ~/.config/fish/completions).

ln -s $HOME/.bloop/fish/bloop.fish ~/.config/fish/completions/bloop.fish

Make sure that the target fish completions directory already exists.

Bloop CLI completions will not work if the build server is not running when the shell is reloaded. Make sure that, before reloading the fish shell, the build server is started.

If you still experience problems, reload the completion script:

source $HOME/.bloop/fish/bloop.fish bloop.fish

Or, if you use Oh My Fish:

omf reload