ContextQMD
Back to Tooljet

ToolJet CLI

docs/versioned_docs/version-3.0.0-LTS/tooljetcli.md

3.20.154-lts2.1 KB
Original Source

ToolJet CLI is a powerful tool that empowers developers to effortlessly create and enhance Marketplace plugins for ToolJet workspace.

:::info Starting from ToolJet CLI version 0.0.14, the creation of datasource plugins has been deprecated to prioritize marketplace plugins. This change enhances the plugin development experience and aligns with ToolJet's roadmap. :::

Installation

In order to manage plugins for the ToolJet marketplace, including creating, updating, and deleting, you will need to utilize tooljet-cli. This can be installed via npm by entering the following command:

bash
npm install -g @tooljet/cli
<div style={{textAlign: 'center'}}> </div>

Ensure the installation was successful

bash
tooljet --version
<div style={{textAlign: 'center'}}> </div>

Commands

info

This command returns the information about where tooljet is being run

bash
tooljet info
<div style={{textAlign: 'center'}}> </div>

create

This command creates a new plugin.

bash
tooljet plugin create PLUGIN_NAME

:::tip Read the detailed guide on creating a marketplace plugin here. :::

<div style={{textAlign: 'center'}}> </div>

delete

This command deletes a plugin.

bash
tooljet plugin delete PLUGIN_NAME

The CLI will prompt developers to verify if the plugin to be deleted is a marketplace plugin before proceeding with the deletion.

<div style={{textAlign: 'center'}}> </div>

install

Installs a new npm module inside a tooljet plugin

bash
tooljet plugin install [NPM_MODULE] --plugin <value>