Quick Start

Follow these steps to create a Terminus project.

Pre-requisites

You must have sbt installed. Follow the instructions to install sbt (and Scala) if you don't already have it.

Basic Project

Run

sbt new scala/scala3.g8

to create a new project. It doesn't matter what name you give this project. Something simple, like terminal, will do.

Open build.sbt in the project you just created. Above the line that starts with libraryDependencies add

libraryDependencies += "org.creativescala" %%% "terminus-core" % "0.3",

Note the trailing comma on this line. sbt will be upset if you don't add this.

Now open src/main/scala/Main.scala and replace the code with

import terminus.*

@main def hello(): Unit =
  Terminal.run {
    Terminal.display.bold {
      Terminal.foreground.green {
        Terminal.write("This is Terminus!")
        Terminal.flush()
      }
    }
  }

Now run the command sbt run and you should see output like that below on the terminal.

That's all you need to get started. Read the rest of the documentation to learn more about Terminus' capabilities.