Skip to main content

Installation

Follow the steps below to set up sqlink on your system.

Prerequisites​

Before installing sqlink, ensure that the following are installed and configured:

  • Node.js version 18 or above
  • npm (comes bundled with Node.js)
  • MySQL database (either locally installed or running in Docker)

Installation​

macOS / Linux​

Open your terminal and run:

Terminal
$
sudo npm install -g sqlink

Windows​

Open Command Prompt or PowerShell and run:

Terminal
$
npm install -g sqlink

Verify Installation​

Once the installation is complete, verify it by checking the installed version:

Terminal
$
sqlink --version

If the installation was successful, the command will display the currently installed version of sqlink.