__

┌─┐┌─┐┌─┐┌─┐┌┬┐┌─┐┌─┐┬┌─ ┬ ┌┐┌┌─┐┌┬┐┌─┐┬ ┬ ┌─┐┬─┐ └─┐├─┤├─┤└─┐ │ ├─┤│ ├┴┐ │ │││└─┐ │ ├─┤│ │ ├┤ ├┬┘ └─┘┴ ┴┴ ┴└─┘ ┴ ┴ ┴└─┘┴ ┴ ┴ ┘└┘└─┘ ┴ ┴ ┴┴─┘┴─┘└─┘┴└─

This is a CLI tool that is used by members of the SaaStack community to update their codebases with the latest assets from the SaaStack Standard and Premium codebases.

Install

You must first install the tool, using the following command:

dotnet tool install --global SaaStack-Installer

You can also make sure you have the latest version installed, by using this command:

dotnet tool update --global SaaStack-Installer

Preparation

Correct Location

Next, in your terminal, make sure you are in the root directory of your codebase. (Not in the src subdirectory) or any others.

This is very important, as the tool will copy files into your codebase in various directories, expecting to be in the root of the repository.

Clean Working Directory

Next, make sure that if you have any local changes, that you have committed them, or stashed them, as the tool might overwrite some of your local changes.

You always want to be in the position to review the changes, after running the tool, and rolling back if something goes wrong.

Access

Next, you need to obtain a GitHub Personal Access Token that has enough access to the SaaStack Standard and Premium repositories. You should already have access to the SaaStack Standard repository, as a GitHub user, as a member of the SaaStack community. This is an extra step that you need to do to give your permission to the SaaStack-Installer installer tool.

In your GitHub settings, create yourself a personal access token (classic), with at least the scope. We strongly recommend having this token expire in 7 days. You can always create a new one later, and delete this one then.