Skip to main content

install

Overview

Taq install is a core CLI task used to install Taqueria plugins

The install task does two things:

  1. It installs the plugin specified from NPM by adding the package and dependencies to node_modules and package.json
  2. It adds the plugin to the Taqueria config.json file

Plugin Implementations

This task can be used to install the following plugins:

Name<pluginName>Description
Core@taqueria/plugin-coreContains core utility tasks provided by Taqueria
Archetype@taqueria/plugin-archetypeA compiler for the Archetype smart contract language
Contract Types@taqueria/plugin-contract-typesA type generator that produces TS types from Michelson code
Flextesa@taqueria/plugin-flextesaA Tezos sandbox (testnet) that runs locally on your machine
IPFS Pinata@taqueria/plugin-ipfs-pinataPublishes metadata or media files to IPFS via Pinata
Metadata@taqueria/plugin-metadataCreate JSON files containing TZIP-16 compliant metadata for a smart contract
Jest@taqueria/plugin-jestProvides support for Jest testing
LIGO@taqueria/plugin-ligoA compiler for the LIGO smart contract language
SmartPy@taqueria/plugin-smartpyA compiler for the SmartPy smart contract language
Taquito@taqueria/plugin-taquitoA front-end Tezos framework used to originate smart contracts
Octez Client@taqueria/plugin-octez-clientAn abstraction of octez-client, providing simulation and typechecking

Command

taq install <pluginName>

Task Details

Task NameCommandTypeDescription
installtaq install <pluginName>Core CLIInstalls the given plugin

Command-Line Arguments

ArgumentRequiredDescriptionExample Usage
<pluginName>YesThe NPM name of the plugintaq install @taqueria/plugin-ligo

Usage

DescriptionCommandBehaviour
Install a plugintaq install <pluginName>Installs the provided Taqueria plugin from NPM