@saltcorn/cli 0.7.1-beta.3 → 0.7.2-beta.10

package/README.md

@@ -20,7 +20,7 @@ $ npm install -g @saltcorn/cli
 $ saltcorn COMMAND
 running command...
 $ saltcorn (-v|--version|version)
-@saltcorn/cli/0.7.1-beta.3 darwin-x64 node-v14.16.1
+@saltcorn/cli/0.7.2-beta.10 darwin-arm64 node-v16.15.1
 $ saltcorn --help [COMMAND]
 USAGE
   $ saltcorn COMMAND
@@ -37,7 +37,9 @@ USAGE
 * [`saltcorn create-tenant TENANT`](#saltcorn-create-tenant-tenant)
 * [`saltcorn create-user`](#saltcorn-create-user)
 * [`saltcorn delete-tenants`](#saltcorn-delete-tenants)
+* [`saltcorn delete-user USER_EMAIL`](#saltcorn-delete-user-user_email)
 * [`saltcorn fixtures`](#saltcorn-fixtures)
+* [`saltcorn get-cfg KEY`](#saltcorn-get-cfg-key)
 * [`saltcorn help [COMMAND]`](#saltcorn-help-command)
 * [`saltcorn info`](#saltcorn-info)
 * [`saltcorn install-pack`](#saltcorn-install-pack)
@@ -46,11 +48,17 @@ USAGE
 * [`saltcorn localize-plugin PLUGIN PATH`](#saltcorn-localize-plugin-plugin-path)
 * [`saltcorn make-migration`](#saltcorn-make-migration)
 * [`saltcorn saltcorn migrate`](#saltcorn-saltcorn-migrate)
+* [`saltcorn modify-user USER_EMAIL`](#saltcorn-modify-user-user_email)
 * [`saltcorn plugins`](#saltcorn-plugins)
+* [`saltcorn plugins:inspect PLUGIN...`](#saltcorn-pluginsinspect-plugin)
+* [`saltcorn plugins:install PLUGIN...`](#saltcorn-pluginsinstall-plugin)
+* [`saltcorn plugins:link PLUGIN`](#saltcorn-pluginslink-plugin)
+* [`saltcorn plugins:uninstall PLUGIN...`](#saltcorn-pluginsuninstall-plugin)
+* [`saltcorn plugins:update`](#saltcorn-pluginsupdate)
 * [`saltcorn release VERSION`](#saltcorn-release-version)
 * [`saltcorn reset-schema`](#saltcorn-reset-schema)
 * [`saltcorn restore FILE`](#saltcorn-restore-file)
-* [`saltcorn rm-tenant TENANT`](#saltcorn-rm-tenant-tenant)
+* [`saltcorn rm-tenant`](#saltcorn-rm-tenant)
 * [`saltcorn run-benchmark [BASEURL]`](#saltcorn-run-benchmark-baseurl)
 * [`saltcorn run-tests [PACKAGE]`](#saltcorn-run-tests-package)
 * [`saltcorn scheduler`](#saltcorn-scheduler)
@@ -68,9 +76,12 @@ Add Saltcorn schema to existing database
 ```
 USAGE
   $ saltcorn add-schema
+
+OPTIONS
+  -f, --force  force command execution
 ```
 
-_See code: [src/commands/add-schema.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/add-schema.js)_
+_See code: [src/commands/add-schema.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/add-schema.js)_
 
 ## `saltcorn backup`
 
@@ -86,7 +97,7 @@ OPTIONS
   -z, --zip            zip format
 ```
 
-_See code: [src/commands/backup.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/backup.js)_
+_See code: [src/commands/backup.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/backup.js)_
 
 ## `saltcorn configuration-check`
 
@@ -100,7 +111,7 @@ OPTIONS
   -t, --tenant=tenant  tenant
 ```
 
-_See code: [src/commands/configuration-check.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/configuration-check.js)_
+_See code: [src/commands/configuration-check.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/configuration-check.js)_
 
 ## `saltcorn create-tenant TENANT`
 
@@ -118,7 +129,7 @@ OPTIONS
   -e, --email=email              Email of owner of tenant
 ```
 
-_See code: [src/commands/create-tenant.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/create-tenant.js)_
+_See code: [src/commands/create-tenant.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/create-tenant.js)_
 
 ## `saltcorn create-user`
 
@@ -136,7 +147,7 @@ OPTIONS
   -t, --tenant=tenant      tenant
 ```
 
-_See code: [src/commands/create-user.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/create-user.js)_
+_See code: [src/commands/create-user.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/create-user.js)_
 
 ## `saltcorn delete-tenants`
 
@@ -147,7 +158,28 @@ USAGE
   $ saltcorn delete-tenants
 ```
 
-_See code: [src/commands/delete-tenants.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/delete-tenants.js)_
+_See code: [src/commands/delete-tenants.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/delete-tenants.js)_
+
+## `saltcorn delete-user USER_EMAIL`
+
+Delete user.
+
+```
+USAGE
+  $ saltcorn delete-user USER_EMAIL
+
+ARGUMENTS
+  USER_EMAIL  User to delete
+
+OPTIONS
+  -f, --force          force command execution
+  -t, --tenant=tenant  tenant
+
+DESCRIPTION
+  Command deletes the user specified by USER_EMAIL.
+```
+
+_See code: [src/commands/delete-user.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/delete-user.js)_
 
 ## `saltcorn fixtures`
 
@@ -166,7 +198,25 @@ DESCRIPTION
   This manual step it is never required for users and rarely required for developers
 ```
 
-_See code: [src/commands/fixtures.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/fixtures.js)_
+_See code: [src/commands/fixtures.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/fixtures.js)_
+
+## `saltcorn get-cfg KEY`
+
+Get a configuration value
+
+```
+USAGE
+  $ saltcorn get-cfg KEY
+
+ARGUMENTS
+  KEY  Configuration key
+
+OPTIONS
+  -p, --plugin=plugin  plugin
+  -t, --tenant=tenant  tenant
+```
+
+_See code: [src/commands/get-cfg.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/get-cfg.js)_
 
 ## `saltcorn help [COMMAND]`
 
@@ -183,7 +233,7 @@ OPTIONS
   --all  see all commands in CLI
 ```
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.3.1/src/commands/help.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.18/src/commands/help.ts)_
 
 ## `saltcorn info`
 
@@ -204,7 +254,7 @@ ALIASES
   $ saltcorn paths
 ```
 
-_See code: [src/commands/info.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/info.js)_
+_See code: [src/commands/info.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/info.js)_
 
 ## `saltcorn install-pack`
 
@@ -220,7 +270,7 @@ OPTIONS
   -t, --tenant=tenant  tenant
 ```
 
-_See code: [src/commands/install-pack.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/install-pack.js)_
+_See code: [src/commands/install-pack.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/install-pack.js)_
 
 ## `saltcorn install-plugin`
 
@@ -236,7 +286,7 @@ OPTIONS
   -t, --tenant=tenant        tenant
 ```
 
-_See code: [src/commands/install-plugin.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/install-plugin.js)_
+_See code: [src/commands/install-plugin.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/install-plugin.js)_
 
 ## `saltcorn list-tenants`
 
@@ -247,7 +297,7 @@ USAGE
   $ saltcorn list-tenants
 ```
 
-_See code: [src/commands/list-tenants.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/list-tenants.js)_
+_See code: [src/commands/list-tenants.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/list-tenants.js)_
 
 ## `saltcorn localize-plugin PLUGIN PATH`
 
@@ -265,7 +315,7 @@ OPTIONS
   -t, --tenant=tenant  tenant
 ```
 
-_See code: [src/commands/localize-plugin.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/localize-plugin.js)_
+_See code: [src/commands/localize-plugin.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/localize-plugin.js)_
 
 ## `saltcorn make-migration`
 
@@ -281,7 +331,7 @@ DESCRIPTION
   unless you are a developer.
 ```
 
-_See code: [src/commands/make-migration.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/make-migration.js)_
+_See code: [src/commands/make-migration.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/make-migration.js)_
 
 ## `saltcorn saltcorn migrate`
 
@@ -303,34 +353,174 @@ DESCRIPTION
   servers and need to control when the migrations are run.
 ```
 
-_See code: [src/commands/migrate.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/migrate.js)_
+_See code: [src/commands/migrate.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/migrate.js)_
+
+## `saltcorn modify-user USER_EMAIL`
+
+Modify (update) user.
+
+```
+USAGE
+  $ saltcorn modify-user USER_EMAIL
+
+ARGUMENTS
+  USER_EMAIL  User to modify
+
+OPTIONS
+  -a, --admin              make user be Admin
+  -e, --email=email        new email
+  -i, --imode              interactive mode
+  -p, --password=password  new password
+  -r, --role=role          new role (can conflict with -a option)
+  -t, --tenant=tenant      tenant
+
+DESCRIPTION
+  Command changes the user specified by USER_EMAIL.
+
+  You can change the user group, password and email.
+
+  NOTE that -a and -r role (--role=role) can give conflict.
+```
+
+_See code: [src/commands/modify-user.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/modify-user.js)_
 
 ## `saltcorn plugins`
 
-List and upgrade plugins for tenants
+List installed plugins.
 
 ```
 USAGE
   $ saltcorn plugins
 
 OPTIONS
-  -d, --dryRun     Upgrade dry-run
-  -f, --force      Force update
-  -n, --name=name  Plugin name
-  -u, --upgrade    Upgrade
-  -v, --verbose    Verbose output
+  --core  Show core plugins.
+
+EXAMPLE
+  $ saltcorn plugins
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.0/src/commands/plugins/index.ts)_
+
+## `saltcorn plugins:inspect PLUGIN...`
+
+Displays installation properties of a plugin.
+
+```
+USAGE
+  $ saltcorn plugins:inspect PLUGIN...
+
+ARGUMENTS
+  PLUGIN  [default: .] Plugin to inspect.
+
+OPTIONS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+EXAMPLE
+  $ saltcorn plugins:inspect myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.0/src/commands/plugins/inspect.ts)_
+
+## `saltcorn plugins:install PLUGIN...`
+
+Installs a plugin into the CLI.
+
+```
+USAGE
+  $ saltcorn plugins:install PLUGIN...
+
+ARGUMENTS
+  PLUGIN  Plugin to install.
+
+OPTIONS
+  -f, --force    Run yarn install with force flag.
+  -h, --help     Show CLI help.
+  -v, --verbose
 
 DESCRIPTION
-  ...
-  Extra documentation goes here
+  Can be installed from npm or a git url.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command 
+  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in 
+  the CLI without the need to patch and update the whole CLI.
+
+ALIASES
+  $ saltcorn plugins:add
 
 EXAMPLES
-  plugins -v - verbose output of commands
-  plugins -u -d - dry-run for plugin update
-  plugins -u -f - force plugin update
+  $ saltcorn plugins:install myplugin 
+  $ saltcorn plugins:install https://github.com/someuser/someplugin
+  $ saltcorn plugins:install someuser/someplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.0/src/commands/plugins/install.ts)_
+
+## `saltcorn plugins:link PLUGIN`
+
+Links a plugin into the CLI for development.
+
+```
+USAGE
+  $ saltcorn plugins:link PLUGIN
+
+ARGUMENTS
+  PATH  [default: .] path to plugin
+
+OPTIONS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Installation of a linked plugin will override a user-installed or core plugin.
+
+  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
+   command will override the user-installed or core plugin implementation. This is useful for development work.
+
+EXAMPLE
+  $ saltcorn plugins:link myplugin
 ```
 
-_See code: [src/commands/plugins.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/plugins.js)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.0/src/commands/plugins/link.ts)_
+
+## `saltcorn plugins:uninstall PLUGIN...`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ saltcorn plugins:uninstall PLUGIN...
+
+ARGUMENTS
+  PLUGIN  plugin to uninstall
+
+OPTIONS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+ALIASES
+  $ saltcorn plugins:unlink
+  $ saltcorn plugins:remove
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.0/src/commands/plugins/uninstall.ts)_
+
+## `saltcorn plugins:update`
+
+Update installed plugins.
+
+```
+USAGE
+  $ saltcorn plugins:update
+
+OPTIONS
+  -h, --help     Show CLI help.
+  -v, --verbose
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.0/src/commands/plugins/update.ts)_
 
 ## `saltcorn release VERSION`
 
@@ -344,7 +534,7 @@ ARGUMENTS
   VERSION  New version number
 ```
 
-_See code: [src/commands/release.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/release.js)_
+_See code: [src/commands/release.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/release.js)_
 
 ## `saltcorn reset-schema`
 
@@ -355,7 +545,7 @@ USAGE
   $ saltcorn reset-schema
 
 OPTIONS
-  -f, --force          force
+  -f, --force          force command execution
   -t, --tenant=tenant  tenant
 
 DESCRIPTION
@@ -363,7 +553,7 @@ DESCRIPTION
   This will delete all existing information
 ```
 
-_See code: [src/commands/reset-schema.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/reset-schema.js)_
+_See code: [src/commands/reset-schema.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/reset-schema.js)_
 
 ## `saltcorn restore FILE`
 
@@ -380,21 +570,26 @@ OPTIONS
   -t, --tenant=tenant  tenant
 ```
 
-_See code: [src/commands/restore.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/restore.js)_
+_See code: [src/commands/restore.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/restore.js)_
 
-## `saltcorn rm-tenant TENANT`
+## `saltcorn rm-tenant`
 
-Remove a tenant
+Remove a tenant.
 
 ```
 USAGE
-  $ saltcorn rm-tenant TENANT
+  $ saltcorn rm-tenant
 
-ARGUMENTS
-  TENANT  Tenant to remove
+OPTIONS
+  -f, --force          force command execution
+  -t, --tenant=tenant  (required) tenant
+
+DESCRIPTION
+  Attention! All tenant data will be lost!
+  It recommended to make backup of tenant before perform this command.
 ```
 
-_See code: [src/commands/rm-tenant.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/rm-tenant.js)_
+_See code: [src/commands/rm-tenant.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/rm-tenant.js)_
 
 ## `saltcorn run-benchmark [BASEURL]`
 
@@ -413,7 +608,7 @@ OPTIONS
   -t, --token=token          API Token for reporting results
 ```
 
-_See code: [src/commands/run-benchmark.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/run-benchmark.js)_
+_See code: [src/commands/run-benchmark.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/run-benchmark.js)_
 
 ## `saltcorn run-tests [PACKAGE]`
 
@@ -433,7 +628,7 @@ OPTIONS
   --watchAll                   Watch files for changes and rerun all tests.
 ```
 
-_See code: [src/commands/run-tests.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/run-tests.js)_
+_See code: [src/commands/run-tests.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/run-tests.js)_
 
 ## `saltcorn scheduler`
 
@@ -447,7 +642,7 @@ OPTIONS
   -v, --verbose  Verbose
 ```
 
-_See code: [src/commands/scheduler.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/scheduler.js)_
+_See code: [src/commands/scheduler.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/scheduler.js)_
 
 ## `saltcorn serve`
 
@@ -467,7 +662,7 @@ OPTIONS
   -v, --verbose      Verbose
 ```
 
-_See code: [src/commands/serve.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/serve.js)_
+_See code: [src/commands/serve.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/serve.js)_
 
 ## `saltcorn set-cfg KEY VALUE`
 
@@ -486,7 +681,7 @@ OPTIONS
   -t, --tenant=tenant  tenant
 ```
 
-_See code: [src/commands/set-cfg.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/set-cfg.js)_
+_See code: [src/commands/set-cfg.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/set-cfg.js)_
 
 ## `saltcorn setup`
 
@@ -501,11 +696,11 @@ OPTIONS
 
 DESCRIPTION
   ...
-  This will attempt to install or connect a database, and set up a 
+  This will attempt to install or connect a database, and set up a
   configuration file
 ```
 
-_See code: [src/commands/setup.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/setup.js)_
+_See code: [src/commands/setup.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/setup.js)_
 
 ## `saltcorn setup-benchmark`
 
@@ -519,7 +714,7 @@ OPTIONS
   -t, --tenant=tenant  tenant
 ```
 
-_See code: [src/commands/setup-benchmark.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/setup-benchmark.js)_
+_See code: [src/commands/setup-benchmark.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/setup-benchmark.js)_
 
 ## `saltcorn test-plugin PATH`
 
@@ -537,7 +732,7 @@ DESCRIPTION
   Extra documentation goes here
 ```
 
-_See code: [src/commands/test-plugin.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/test-plugin.js)_
+_See code: [src/commands/test-plugin.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/test-plugin.js)_
 
 ## `saltcorn transform-field EXPRESSION FIELD TABLE [TENANT]`
 
@@ -554,5 +749,5 @@ ARGUMENTS
   TENANT      tenant name
 ```
 
-_See code: [src/commands/transform-field.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/transform-field.js)_
+_See code: [src/commands/transform-field.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/transform-field.js)_
 <!-- commandsstop -->