mirror of https://github.com/ToolJet/ToolJet synced 2026-04-21 13:37:28 +00:00

History

Arpit 7dea6c9ad1 Enhancements to the process of developing a Marketplace plugin (#5777 ) * in dev mode, start watching for changes in all packages * plugin reload service * typo * fixes updates from fs * checks if marketplace dev mode is on to decode the run code from plugin index file * clean up * removes console.log * refactor: marketplace dashboard * prep to merge * dotenv * fixes: install new upadates for one plugin at a time * fixes app crash for new plugins(marketplace/datasource) with default schema * avoid creating docs for marketplace to root docs * Before starting watcher, build the marketplace once. * fixes: installed plugin crashes if deleting the entire plugin from the dir, but the build still haves the plugin files		2023-03-24 17:05:08 +05:30
..
bin	Add tooljet cli (#1611 )	2022-01-17 22:28:15 +05:30
src/commands	Enhancements to the process of developing a Marketplace plugin (#5777 )	2023-03-24 17:05:08 +05:30
.eslintrc.js	Tooljet CLI deployment and sanity check (#2096 )	2022-02-05 06:49:49 +05:30
.gitignore	Add tooljet cli (#1611 )	2022-01-17 22:28:15 +05:30
package-lock.json	Add tooljet info command to cli (#3345 )	2022-06-22 07:26:23 +05:30
package.json	[Feature] Make plugins installable (#3069 )	2022-10-27 16:59:43 +05:30
README.md	[Feature] Make plugins installable (#3069 )	2022-10-27 16:59:43 +05:30
tsconfig.json	Tooljet CLI deployment and sanity check (#2096 )	2022-02-05 06:49:49 +05:30

README.md

tooljet cli

Usage
Commands

Usage

$ npm install -g @tooljet/cli
$ tooljet COMMAND
running command...
$ tooljet (--version)
@tooljet/cli/0.0.13 darwin-x64 node-v14.17.3
$ 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] [-m]

ARGUMENTS
  PLUGIN_NAME  Name of the plugin

FLAGS
  -b, --build
  -m, --marketplace
  --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]

ARGUMENTS
  PLUGIN_NAME  Name of the plugin

FLAGS
  -b, --build

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>