sbt

1. In the sbt tool window, right-click a linked project.

2. From the context menu, select Reload project .

   On invoking this action, IntelliJ IDEA parses the project structure in the sbt tool window.

   IntelliJ IDEA cannot reload just a part of your project, it reloads the whole project including subprojects and dependencies.

tip

To reload all sbt projects, click on the toolbar, in the sbt tool window.

1. In the Settings dialog () , go to Build, Execution, Deployment | Build Tools.

   Alternatively, In the sbt tool window, click and select the Auto-Reload Settings option.

   

2. In the Build tools settings, specify the following options:

   

   • Reload changes in the build scripts: this option is selected by default. If you want to disable the auto-reload and manually control the reloading process, unselect this checkbox.

   • Any changes: select this option if you want to automatically reload the project after any changes you make to build.sbt or external changes.

     Every time you manually change the sbt build script in the editor, you need to load the changes. IntelliJ IDEA displays a notification icon in the right part of the editor suggesting to Load sbt Changes made to the project ().

     

     With the Any changes option, IntelliJ IDEA reloads all the changes automatically.

   • External changes: when you select this option, IntelliJ IDEA automatically reloads the project only after the VCS changes and changes made to the build files outside the IDE.

• To start the sbt shell, press Ctrl+Shift+S (for Windows) or ⌘+⇧+S (for macOS). Alternatively, click on the toolbar located at the bottom of the screen.

• To use the sbt shell for build and import procedures, select the Use sbt shell section located in the sbt settings and perform steps described in the Run a Scala application using the sbt shell section.

  note

  The sbt versions 0.13.16.+ / 1.0.3.+ are recommended.

• To use the sbt shell for debugging, refer to the debugging with sbt shell section.

• To run your tests from the sbt shell:

  1. Open a run/debug configuration (Run | Edit Configurations).

  2. Create a test configuration and select the use sbt option from the available settings.

  tip

  You can also run test or test/Only command by entering it in the sbt shell.

• You can run sbt tasks by selecting the one you need from the sbt Tasks directory in the sbt tool window.

• You can manually enter your task (code completion is supported) in the sbt shell and run it directly from there.

• You can create a run configuration for a task. For example, you can create a custom task which is not part of the list of tasks located in the sbt tool window.

  1. Press to open a run configuration.

  2. Specify the run configuration settings and click OK. If you need, you can add another configuration or a task to execute before running your configuration. Click in the Before Launch section and from the list that opens, select what you need to execute.

• When you work in the distraction-free mode (without toolbars and tool windows), you can run sbt tasks or commands from the Run Anything window. Press twice to open it, type your command and press .

IntelliJ IDEA displays results in the sbt shell window.

1. Press to open settings and then select Build, Execution, Deployment| sbt.

2. Alternatively, click on the toolbar of the sbt tool window to access the sbt settings.

In General settings you can set the following options:

1. JRE: Choose a JRE to run this project against, either from a dropdown list or by providing a custom location. It takes precedence over the default project SDK.

2. Maximum heap size: The maximum heap size with which sbt starts.

3. VM parameters: JVM parameters passed to sbt. You can also declare JVM options in the JAVA_OPTS environment variable or in the .jvmopts file located in the project root. Options set in the IntelliJ IDEA settings take the highest precedence, followed by options from the .jvmopts file and options from the environment variable.

4. sbt options: sbt options passed to sbt. You can see all available options using the sbt --help command. You can also declare sbt options in the SBT_OPTS environment variable or in the .sbtopts file located in the project root. The priority of options from different sources is analogous to VM parameters.

5. Environment variables: Environment variables injected to an sbt process

6. Launcher: Here you can specify a custom launcher, the default being the bundled sbt-launch.jar

In sbt projects you can set the following options:

1. Download library sources: Download the sources of the project's library dependencies when reloading the project from sbt

2. Download sbt sources: Download the sources of sbt and sbt plugins when reloading the project from sbt

3. Open cross-compiled Scala 3 / Scala 2 projects as Scala 2: Projects that are cross-compiled against both Scala 2 and Scala 3 can be opened as Scala 2

4. Use separate compiler output paths: IntelliJ IDEA will use a different class file directory for compilation than the one used by sbt

5. Create separate modules for main and test resources: Read more in our blog article, New module layout for sbt.

6. sbt shell: Here you can also specify if you want to use sbt shell for project reloads and for building. Using sbt shell for reloading is faster but it requires IntelliJ IDEA to keep the shell in the memory.