Skip to main content

Installation

To begin using VulcanSQL, you first need to install the VulcanSQL CLI. The VulcanSQL CLI is a command-line tool that assists in initializing a VulcanSQL project, building your data API server, and starting the server.

Install From Binary​

We provide pre-built binaries for Linux, macOS, and Windows. The binary includes all dependencies, so you don't need to install any additional dependencies.

Let's go ahead and grab the newest version of VulcanSQL CLI from this link: vulcan. Once the download is complete, you'll need to extract the file and move it to /usr/local/bin:

tar zxvf vulcan.osx.tar.gz
mv vulcan /usr/local/bin

Install from NPM​

Preparing the installation​

Before installing the VulcanSQL CLI from NPM, make sure the following requirements are installed on your computer:

  • Node.js: Only versions above v16 are supported.
  • Your preferred Node.js package manager: NPM or Yarn

NPM Install​

npm i -g @vulcan-sql/cli

Install from Pip​

Preparing the installation​

Before installing the VulcanSQL CLI from Pip, make sure the following requirements are installed on your computer:

  • Python: Currently we support versions 3.3.x to 3.11.x

Pip Install​

$ pip install vulcan-sql
$ vulcan --help

Next Step​

After installing VulcanSQL CLI, you can start initializing your project. Head to Create Your First Data API to learn how to create your first API.