Skip to content

SAFE installation and setup

The desktop application will ensure that a proper configuration is created which will allow the CI/CD integration of SAFE to work properly. You cannot run an analysis directly on the desktop app. Steps to configure the CI/CD are available here CI/CD

Download SAFE from this link.

macOS


Place the SAFE.app in your Applications Folder:

Image title
Safe app

Linux


For linux simple double click on the .deb package and it will start. or:

sudo apt install <path_to_package>

Project setup

Start by clicking the 'Add Project' button on the main page to begin setting up your project for configuration

Image title
Add project

Project type selection

Choose Project Language: Select either Erlang or Elixir depending on your codebase to ensure proper analysis compatibility.

Image title
select type

Project root folder selection

Click 'Browse' to navigate to the root directory of the repository. This will allow the tool to scan the entire codebase for analysis."

Image title
Provide the project path

Please wait while the configuration is being calculated. The process may take a few moments depending on project size.

Image title
Creating the config file...

Notice

If issues are detected in your setup, the wizard will display error prompts with specific remediation suggestions. Follow these to address configuration errors.

Select the plan and request a License by providing an email address, you will receive the payment details.

Image title
Creating the config file...

Info

If you have an open-source repository, please follow the same steps, additionally after requesting the license please send us an email at safe@erlang-solutions.com specifying the open-source repository where you'd like to use SAFE (e.g., include the GitHub link). This will help us ensure the right license is sent for that specific repository and provide any necessary support.