Skip to main content

Prerequisites

Installation prerequisites

Safira CLI installation and use requires a few OS components and 3rd party tools listed below:

  • docker the purpose is to generate the containers of the applications that are built by Safira-CLI
  • curl is used for sapphire installation
  • java8+ generate the API project template
  • git utilized in routines within Safira-CLI
  • node16+ serves for command execution
tip

You can use safira-doctor to check dependencies automatically.

OS Dependencies

A few common shell utilities are used during Safira CLI install (like curl and unzip). In case you don't have them yet, just install like below:

sudo apt update sudo apt install zip unzip curl -y

Installing Docker

Docker is the "de facto" standard for containers in the developer's workstation. Docker Desktop is a higher-level tool that includes the Docker Engine, but in Linux systems you can install just the Engine natively.

More about Docker Desktop

  # install Docker Engine
curl -fsSL https://get.docker.com -o get-docker.sh
sudo sh get-docker.sh
# add user to docker group
sudo usermod -aG docker $USER

Installing Java using SdkMan

Java runtimes will be needed to create SpringBoot and Quarkus API projects. We recommend using SkdMan to manage JDK installations on your machine.

More about SdkMan

curl -s "https://get.sdkman.io" | bash
source "$HOME/.sdkman/bin/sdkman-init.sh"
source ~/.bashrc
sdk install java 11.0.12-open

Install Node16 using nvm

Node runtime will be needed to create Node-based API projects (still under construction). We recommend using nvm to manage Node installations on your machine.

More about nvm

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
source ~/.bashrc # or equivalent
nvm install 16