ToolJet/docs/versioned_docs/version-2.27.0/tooljetcli.md

94 lines
2.2 KiB
Markdown
Raw Permalink Normal View History

---
id: tooljet-cli
title: ToolJet CLI
---
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 prioritise 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](https://www.npmjs.com/package/@tooljet/cli)**. This can be installed via npm by entering the following command:
```bash
npm install -g @tooljet/cli
```
<div style={{textAlign: 'center'}}>
<img className="screenshot-full" src="/img/tooljet-cli/install.png" alt="ToolJet CLI installation" />
</div>
#### Ensure the installation was successful
```bash
tooljet --version
```
<div style={{textAlign: 'center'}}>
<img className="screenshot-full" src="/img/tooljet-cli/version.png" alt="ToolJet CLI version check" />
</div>
## Commands
### Info
This command returns the information about where tooljet is being run
```bash
tooljet info
```
<div style={{textAlign: 'center'}}>
<img className="screenshot-full" src="/img/tooljet-cli/info.png" alt="ToolJet CLI info" />
</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](/docs/contributing-guide/marketplace/creating-a-plugin).
:::
<div style={{textAlign: 'center'}}>
<img className="screenshot-full" src="/img/tooljet-cli/create.gif" alt="ToolJet CLI : create plugin" />
</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'}}>
<img className="screenshot-full" src="/img/tooljet-cli/delete.gif" alt="ToolJet CLI: delete plugin" />
</div>
### Install
Installs a new npm module inside a tooljet plugin
```bash
tooljet plugin install [NPM_MODULE] --plugin <value>
```