2022-01-17 16:58:15 +00:00
|
|
|
tooljet cli
|
|
|
|
|
=================
|
|
|
|
|
<!-- toc -->
|
|
|
|
|
* [Usage](#usage)
|
|
|
|
|
* [Commands](#commands)
|
|
|
|
|
<!-- tocstop -->
|
|
|
|
|
# Usage
|
|
|
|
|
<!-- usage -->
|
|
|
|
|
```sh-session
|
2022-02-05 01:19:49 +00:00
|
|
|
$ npm install -g @tooljet/cli
|
2022-01-17 16:58:15 +00:00
|
|
|
$ tooljet COMMAND
|
|
|
|
|
running command...
|
|
|
|
|
$ tooljet (--version)
|
2022-10-27 11:29:43 +00:00
|
|
|
@tooljet/cli/0.0.13 darwin-x64 node-v14.17.3
|
2022-01-17 16:58:15 +00:00
|
|
|
$ tooljet --help [COMMAND]
|
|
|
|
|
USAGE
|
|
|
|
|
$ tooljet COMMAND
|
|
|
|
|
...
|
|
|
|
|
```
|
|
|
|
|
<!-- usagestop -->
|
2022-02-05 01:19:49 +00:00
|
|
|
|
|
|
|
|
Command should be executed inside `Tooljet` directory
|
|
|
|
|
|
2022-01-17 16:58:15 +00:00
|
|
|
# Commands
|
|
|
|
|
<!-- commands -->
|
2022-06-22 01:56:23 +00:00
|
|
|
* [`tooljet info`](#tooljet-info)
|
2022-01-17 16:58:15 +00:00
|
|
|
* [`tooljet plugin create PLUGIN_NAME`](#tooljet-plugin-create-plugin_name)
|
|
|
|
|
* [`tooljet plugin delete PLUGIN_NAME`](#tooljet-plugin-delete-plugin_name)
|
|
|
|
|
* [`tooljet plugin install NPM_MODULE`](#tooljet-plugin-install-npm_module)
|
|
|
|
|
|
2022-06-22 01:56:23 +00:00
|
|
|
## `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
|
|
|
|
|
```
|
|
|
|
|
|
2022-10-27 11:29:43 +00:00
|
|
|
_See code: [dist/commands/info.ts](https://github.com/tooljet/tooljet/blob/v0.0.13/dist/commands/info.ts)_
|
|
|
|
|
|
2022-01-17 16:58:15 +00:00
|
|
|
## `tooljet plugin create PLUGIN_NAME`
|
|
|
|
|
|
2022-10-27 11:29:43 +00:00
|
|
|
Create a new tooljet plugin
|
2022-01-17 16:58:15 +00:00
|
|
|
|
|
|
|
|
```
|
|
|
|
|
USAGE
|
2022-10-27 11:29:43 +00:00
|
|
|
$ tooljet plugin create [PLUGIN_NAME] [--type database|api|cloud-storage] [-b] [-m]
|
2022-01-17 16:58:15 +00:00
|
|
|
|
|
|
|
|
ARGUMENTS
|
|
|
|
|
PLUGIN_NAME Name of the plugin
|
|
|
|
|
|
|
|
|
|
FLAGS
|
2022-02-05 01:19:49 +00:00
|
|
|
-b, --build
|
2022-10-27 11:29:43 +00:00
|
|
|
-m, --marketplace
|
|
|
|
|
--type=<option> <options: database|api|cloud-storage>
|
2022-01-17 16:58:15 +00:00
|
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
|
Create a new tooljet plugin
|
|
|
|
|
|
|
|
|
|
EXAMPLES
|
2022-02-05 01:19:49 +00:00
|
|
|
$ tooljet plugin create <name> --type=<database | api | cloud-storage> [--build]
|
2022-01-17 16:58:15 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## `tooljet plugin delete PLUGIN_NAME`
|
|
|
|
|
|
2022-10-27 11:29:43 +00:00
|
|
|
Delete a tooljet plugin
|
2022-01-17 16:58:15 +00:00
|
|
|
|
|
|
|
|
```
|
|
|
|
|
USAGE
|
2022-02-05 01:19:49 +00:00
|
|
|
$ tooljet plugin delete [PLUGIN_NAME] [-b]
|
2022-01-17 16:58:15 +00:00
|
|
|
|
|
|
|
|
ARGUMENTS
|
|
|
|
|
PLUGIN_NAME Name of the plugin
|
|
|
|
|
|
2022-02-05 01:19:49 +00:00
|
|
|
FLAGS
|
|
|
|
|
-b, --build
|
|
|
|
|
|
2022-01-17 16:58:15 +00:00
|
|
|
DESCRIPTION
|
2022-10-27 11:29:43 +00:00
|
|
|
Delete a tooljet plugin
|
2022-01-17 16:58:15 +00:00
|
|
|
|
|
|
|
|
EXAMPLES
|
2022-02-05 01:19:49 +00:00
|
|
|
$ tooljet plugin delete <name> [--build]
|
2022-01-17 16:58:15 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## `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>
|
|
|
|
|
```
|
|
|
|
|
<!-- commandsstop -->
|
