Installation

Installation on Windows, macOS, and Linux systems is easy.

Windows

  1. Download the installer MSI, run it, and follow the instructions. An uninstaller will be included.
  2. SQribe executable and dependency files are copied to a C:\Program Files\SQribe folder.
  3. Your environment path is modified to allow SQribe to be run from anywhere on your local storage.
  4. When run for the first time, SQribe will create a folder named sqribe in your user home folder (~/sqribe/). This folder will be used for the activity log, your license, and will also be searched for job scripts along with the current directory as a convenience.

Uninstall: Run the SQribe installer, or use the Add/Remove Programs control panel as is usual. You can then delete the ~/sqribe/ data folder if desired.

macOS

  1. Download the installer package, run it, and follow the instructions. You will need to enter an administrator password to complete the installation.
  2. SQribe executable and dependency files are copied to your startup disk in the Applications/SQribe folder.
  3. Your environment path is modified to allow SQribe to be run from anywhere on your local storage via a file named SQribe.public in your /etc/paths.d folder.
  4. When run for the first time, SQribe will create a folder named sqribe in your user home folder (~/sqribe/). This folder will be used for the activity log, your license, and will also be searched for job scripts along with the current directory as a convenience.

Uninstall: Trash the Applications/SQribe folder, and delete the file SQribe.public in your /etc/paths.d folder. You can then delete the ~/sqribe/ data folder if desired.

Linux

  1. Download the installer ZIP file and extract it to a location of your choice.
  2. Add the path to SQribe to your environment to allow SQribe to be run from anywhere on your local storage.
  3. When run for the first time, SQribe will create a folder named sqribe in your user home folder (~/sqribe/). This folder will be used for the activity log, your license, and will also be searched for job scripts along with the current directory as a convenience.

Uninstall: Delete the SQribe folder and remove SQribe from your environment path. You can then delete the ~/sqribe/ data folder if desired.

Activate your license

SQribe can be used for 30 days by registering on the website as a new user with a unique email address. You will be given a 30-day trial license. In order to use SQribe beyond the trial period, you need to purchase a subscription.

Automatic SQribe license activation (trial or purchased)

Simply run SQribe in the command line by typing "sqribe" and it will ask you to sign in so that it can download and install your license.

That's it!

SQribe will try to download a new license when the current one expires. If your password has been changed, SQribe will ask you to re-authenticate when it checks for a license update.

Running SQribe and activating your license in Windows PowerShell.
Running SQribe and activating your license in macOS Terminal.

Manual SQribe license activation (trial or purchased)

Sign in to the SQribe website member portal, and download your license.json file. Copy the file into the SQribe data folder (in your user home folder) at ~/sqribe/. This is best for annual or longer subscriptions, and for using SQribe on machines without an Internet connection.