@tooljet/cli

tooljet cli

• Usage
• Commands

Usage

$ npm install -g @tooljet/cli
$ tooljet COMMAND
running command...
$ tooljet (--version)
@tooljet/cli/0.0.14 darwin-arm64 node-v18.3.0
$ tooljet --help [COMMAND]
USAGE
  $ tooljet COMMAND
...

Command should be executed inside Tooljet directory

Commands

• tooljet info
• tooljet plugin create PLUGIN_NAME
• tooljet plugin delete PLUGIN_NAME
• tooljet plugin install NPM_MODULE

tooljet info

This command returns the information about where tooljet is being run

USAGE
  $ tooljet info

DESCRIPTION
  This command returns the information about where tooljet is being run

See code: dist/commands/info.ts

tooljet plugin create PLUGIN_NAME

Create a new tooljet plugin

USAGE
  $ tooljet plugin create [PLUGIN_NAME] [--type database|api|cloud-storage] [-b]

ARGUMENTS
  PLUGIN_NAME  Name of the plugin

FLAGS
  -b, --build
  --type=<option>  <options: database|api|cloud-storage>

DESCRIPTION
  Create a new tooljet plugin

EXAMPLES
  $ tooljet plugin create <name> --type=<database | api | cloud-storage> [--build]

tooljet plugin delete PLUGIN_NAME

Delete a tooljet plugin

USAGE
  $ tooljet plugin delete [PLUGIN_NAME] [-b] [-m]

ARGUMENTS
  PLUGIN_NAME  Name of the plugin

FLAGS
  -b, --build
  -m, --marketplace

DESCRIPTION
  Delete a tooljet plugin

EXAMPLES
  $ tooljet plugin delete <name> [--build]

tooljet plugin install NPM_MODULE

Installs a new npm module inside a tooljet plugin

USAGE
  $ tooljet plugin install [NPM_MODULE] --plugin <value>

ARGUMENTS
  NPM_MODULE  Name of the npm module

FLAGS
  --plugin=<value>  (required)

DESCRIPTION
  Installs a new npm module inside a tooljet plugin

EXAMPLES
  $ tooljet plugin install <npm_module> --plugin <plugin_name>