Skip to main content

Install the Velas Tool Suite

There are multiple ways to install the Velas tools on your computer depending on your preferred workflow:

Use Velas Install Tool​

MacOS & Linux​

  • Open your favorite Terminal application

  • Install the Velas release LATEST_VELAS_RELEASE on your machine by running:

curl -sSf https://raw.githubusercontent.com/velas/velas-chain/develop/install/velas-install-init.sh | sh -s - LATEST_VELAS_RELEASE

  • If you are connecting to a different testnet, you can replace LATEST_VELAS_RELEASE with the release tag matching the software version of your desired testnet, or replace it with the named channel stable, beta, or edge.

  • The following output indicates a successful update:

looking for latest release
downloading LATEST_VELAS_RELEASE installer
Configuration: /home/velas/.config/velas/install/config.yml
Active release directory: /home/velas/.local/share/velas/install/active_release
* Release version: LATEST_VELAS_RELEASE
* Release URL: https://github.com/velas/velas-chain/releases/download/LATEST_VELAS_RELEASE/velas-release-x86_64-unknown-linux-gnu.tar.bz2
Update successful
  • Depending on your system, the end of the installer messaging may prompt you to
Please update your PATH environment variable to include the velas programs:
  • If you get the above message, copy and paste the recommended command below it to update PATH

export PATH="/root/.local/share/velas/install/active_release/bin:$PATH" to bashrc

  • Confirm you have the desired version of velas installed by running:
velas --version
  • After a successful install, velas-install update may be used to easily update the Velas software to a newer version at any time.

Windows​

  • Open a Command Prompt (cmd.exe) as an Administrator

    • Search for Command Prompt in the Windows search bar. When the Command Prompt app appears, right-click and select “Open as Administrator”. If you are prompted by a pop-up window asking “Do you want to allow this app to make changes to your device?”, click Yes.

  • Copy and paste the following command, then press Enter to download the Velas installer into a temporary directory:

curl -L https://github.com/velas/velas-chain/releases/download/v0.5.1/velas-install-init-x86_64-pc-windows-msvc.exe --output C:\velas-install-tmp\velas-install-init.exe --create-dirs
  • Copy and paste the following command, then press Enter to install the latest stable version of Velas. If you see a security pop-up by your system, please select to allow the program to run.
C:\velas-install-tmp\velas-install-init.exe stable

  • When the installer is finished, press Enter.

  • Close the command prompt window and re-open a new command prompt window as a normal user

    • Search for "Command Prompt" in the search bar, then left click on the Command Prompt app icon, no need to run as Administrator)

  • Confirm you have the desired version of velas installed by entering:

velas --version
  • After a successful install, velas-install update may be used to easily update the Velas software to a newer version at any time.

Download Prebuilt Binaries​

If you would rather not use velas-install to manage the install, you can manually download and install the binaries.

Linux​

Download the binaries by navigating to https://github.com/velas/velas-chain/releases/latest, download velas-release-x86_64-unknown-linux-msvc.tar.bz2, then extract the archive:

tar jxf velas-release-x86_64-unknown-linux-gnu.tar.bz2
cd velas-release/
export PATH=$PWD/bin:$PATH

MacOS​

Download the binaries by navigating to https://github.com/velas/velas-chain/releases/latest, download velas-release-x86_64-apple-darwin.tar.bz2, then extract the archive:

tar jxf velas-release-x86_64-apple-darwin.tar.bz2
cd velas-release/
export PATH=$PWD/bin:$PATH

Windows​

  • Download the binaries by navigating to https://github.com/velas/velas-chain/releases/latest, download velas-release-x86_64-pc-windows-msvc.tar.bz2, then extract the archive using WinZip or similar.

  • Open a Command Prompt and navigate to the directory into which you extracted the binaries and run:

cd velas-release/
set PATH=%cd%/bin;%PATH%

Build From Source​

If you are unable to use the prebuilt binaries or prefer to build it yourself from source, navigate to https://github.com/velas/velas-chain/releases/latest, and download the Source Code archive. Extract the code and build the binaries with:

./scripts/cargo-install-all.sh .
export PATH=$PWD/bin:$PATH