Skip to main content

Quick Start

Prerequisites

You need a usual Scala development environment: JDK, sbt, scala-cli an IDE of your choice.

You also can use Scala CLI instead of SBT. See AdaStream for an example of a project that uses Scala CLI.

The easiest way to get started is to use Nix package manager.

Clone Scalus Starter Project

Clone the Scalus Starter Project to get started with Scalus.

If you use Nix, we provided flakes.nix file to get a development environment with all the required tools installed.

git clone https://github.com/nau/scalus-starter.git
cd scalus-starter
nix develop
code .
scala-cli run .

Sbt project setup

Add the following to your build.sbt file:

scalaVersion := "3.3.4"
libraryDependencies += "org.scalus" %% "scalus" % "0.8.2"
addCompilerPlugin("org.scalus" %% "scalus-plugin" % "0.8.2")

That's it! You can now start using Scalus in your project.