Installation

Taqueria Installation Basics

Installing Taqueria is a quick and easy process if you understand a few basic concepts and follow the steps outlined in this guide

There are two main components you can install:

• The Taqueria CLI (required)
• The VS Code plugin for Taqueria (optional)

note

The Taqueria CLI is required to use the VS Code extension and as such, must be installed first

Requirements

Taqueria CLI

• Node.js v18.18 or later.
• A compatible operating system:
  • MacOS
  • Linux
  • Windows (via WSL 2)
• Docker v20.10.12 or later

Installing the Taqueria CLI

Overview

The Taqueria CLI is an executable binary named taq.

Installing the Taqueria CLI involves the following steps:

1. Download the correct build of Taqueria for your operating system
2. Make the Taqueria binary taq executable
3. Add taq to your shell's $PATH

To install, we recommend our one-line installer:

/bin/bash -c "$(wget -O - https://taqueria.io/install-taq.sh 2>/dev/null || curl -fsSL https://taqueria.io/install-taq.sh)"

Alternative OS Specific Instructions

MacOS

1. Download the latest MacOS build of Taqueria

For MacOS installations, we recommend using Homebrew:

brew tap TezosTaqueria/taqueria https://github.com/TezosTaqueria/taqueria
brew install taqueria

Linux

1. Download the latest Linux build of Taqueria

curl -LO https://taqueria.io/get/linux/taq

2. Make the binary file executable

chmod +x taq

3. Move the binary to a directory in your shell's $PATH

sudo mv taq /usr/local/bin

Windows

Windows users will run the Linux version of Taqueria in Ubuntu using the Windows Subsystem for Linux (WSL 2)

Requirements

You must be running Windows 10 version 2004 and higher, or Windows 11

Install WSL 2

1. Open a Power Shell or Windows Command Prompt as an administrator and run:

   wsl --install

2. Restart your machine

3. Open the Ubuntu distribution using the Start if it doesn't start automatically after restarting

4. Create a user name and password

Install Docker Desktop WSL 2 backend

1. Download Docker Desktop for Windows

2. Run the installer making sure to enable WSL 2 during the installation if prompted

3. Start Docker Desktop from the Windows Start menu

4. From the Docker menu, navigate to Settings > General and select Use WSL 2 based engine if not already selected

5. Click Apply & Restart

To confirm that Docker Desktop backend has been installed properly, open a WSL 2 terminal and run:

wsl.exe -l -v

You should see the following output:

NAME                   STATE           VERSION 
* Ubuntu               Running         2 
docker-desktop-data    Running         2 
docker-desktop         Running         2

Install Node v16

1. Update the apt package index:

sudo apt update

2. Install dependencies:

sudo apt install curl git

3. Download Node.js v18.18 or later.

curl -sL https://deb.nodesource.com/setup_16.x | sudo -E bash -

4. (Optional) Install the node development tools

sudo apt-get install gcc g++ make

To confirm that Node v16.x has been installed properly, open a new WSL 2 terminal and run:

node --version

You should see v16.x.x or similar returned.

Install the Taqueria Binary

1. Download the latest Linux build of Taqueria

curl -LO https://taqueria.io/get/linux/taq

2. Make the binary file executable

chmod +x taq

3. Move the binary to a directory in your shell's $PATH

sudo mv taq /usr/local/bin

Test the CLI

At this point, Taqueria should be installed and ready to use. You can test this by running the following command:

taq --version

You should see the version of Taqueria installed output:

0.64.0

If you see this, you have successfully installed the Taqueria CLI!

Installing the VS Code Extension (optional)

The Taqueria VS Code Extension is installed from the Extensions pane within VS Code. The steps to install are:

1. Open the Extensions pane
2. Type Taqueria in the search bar
3. Click install