@saltcorn/cli 0.6.0 → 0.6.1

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"0.6.0","commands":{"add-schema":{"id":"add-schema","description":"Add Saltcorn schema to existing database","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"backup":{"id":"backup","description":"Backup the PostgreSQL database to a file with pg_dump or zip","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{"output":{"name":"output","type":"option","char":"o","description":"output filename"},"tenant":{"name":"tenant","type":"option","char":"t","description":"tenant"},"zip":{"name":"zip","type":"boolean","char":"z","description":"zip format","allowNo":false}},"args":[]},"create-tenant":{"id":"create-tenant","description":"Create a tenant","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{"email":{"name":"email","type":"option","char":"e","description":"Email of owner of tenant"},"description":{"name":"description","type":"option","char":"d","description":"Description of tenant"}},"args":[{"name":"tenant","description":"Tenant subdomain to create","required":true}]},"create-user":{"id":"create-user","description":"Create a new user","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{"admin":{"name":"admin","type":"boolean","char":"a","description":"Admin user","allowNo":false},"tenant":{"name":"tenant","type":"option","char":"t","description":"tenant"},"email":{"name":"email","type":"option","char":"e","description":"email"},"role":{"name":"role","type":"option","char":"r","description":"role"},"password":{"name":"password","type":"option","char":"p","description":"password"}},"args":[]},"fixtures":{"id":"fixtures","description":"Load fixtures for testing\n...\nThis manual step it is never required for users and rarely required for developers\n","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{"reset":{"name":"reset","type":"boolean","char":"r","description":"Also reset schema","allowNo":false}},"args":[]},"info":{"id":"info","description":"Show paths\n...\nShow configuration and file store paths\n","pluginName":"@saltcorn/cli","pluginType":"core","aliases":["paths"],"flags":{"json":{"name":"json","type":"boolean","char":"j","description":"json format","allowNo":false}},"args":[]},"install-pack":{"id":"install-pack","description":"Install a pack","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{"tenant":{"name":"tenant","type":"option","char":"t","description":"tenant"},"name":{"name":"name","type":"option","char":"n","description":"Pack name in store"},"file":{"name":"file","type":"option","char":"f","description":"File with pack JSON"}},"args":[]},"install-plugin":{"id":"install-plugin","description":"Install a plugin","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{"tenant":{"name":"tenant","type":"option","char":"t","description":"tenant"},"name":{"name":"name","type":"option","char":"n","description":"Plugin name in store"},"directory":{"name":"directory","type":"option","char":"d","description":"Directory with local plugin"}},"args":[]},"list-tenants":{"id":"list-tenants","description":"List tenants in CSV format","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"localize-plugin":{"id":"localize-plugin","description":"Convert plugin to local plugin","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"plugin","description":"Current plugin name","required":true},{"name":"path","description":"path to local plugin","required":true}]},"make-migration":{"id":"make-migration","description":"Create a new blank Database structure migration file.\nThese migrations update database structure.\nYou should not normally need to run this\nunless you are a developer.\n","usage":"make-migration","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"migrate":{"id":"migrate","description":"Run Database structure migrations\n...\nNOTE!\n- Please stop Saltcorn before run DB migrations.\n- Please make db backup before migration.\n- There are no way to rollback migration if you doesn't make backup.\n\nThis is not normally required as migrations will be run when the server starts.\nHowever, this command may be useful if you are running multiple application\nservers and need to control when the migrations are run.\n","usage":"saltcorn migrate","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"plugins":{"id":"plugins","description":"List and upgrade plugins for tenants\n...\nExtra documentation goes here\n","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"examples":["plugins -v - verbose output of commands","plugins -u -d - dry-run for plugin update","plugins -u -f - force plugin update"],"flags":{"upgrade":{"name":"upgrade","type":"boolean","char":"u","description":"Upgrade","allowNo":false},"dryRun":{"name":"dryRun","type":"boolean","char":"d","description":"Upgrade dry-run","allowNo":false},"verbose":{"name":"verbose","type":"boolean","char":"v","description":"Verbose output","allowNo":false},"force":{"name":"force","type":"boolean","char":"f","description":"Force update","allowNo":false},"name":{"name":"name","type":"option","char":"n","description":"Plugin name"}},"args":[]},"release":{"id":"release","description":"Release a new saltcorn version","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"version","description":"New version number","required":true}]},"reset-schema":{"id":"reset-schema","description":"Reset the database\n...\nThis will delete all existing information\n","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{"force":{"name":"force","type":"boolean","char":"f","description":"force","allowNo":false},"tenant":{"name":"tenant","type":"option","char":"t","description":"tenant"}},"args":[]},"restore":{"id":"restore","description":"Restore a previously backed up database (zip or sqlc format)","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{"tenant":{"name":"tenant","type":"option","char":"t","description":"tenant"}},"args":[{"name":"file","description":"backup file to restore","required":true}]},"rm-tenant":{"id":"rm-tenant","description":"Remove a tenant","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"tenant","description":"Tenant to remove","required":true}]},"run-benchmark":{"id":"run-benchmark","description":"Run benchmark","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{"token":{"name":"token","type":"option","char":"t","description":"API Token for reporting results"},"benchmark":{"name":"benchmark","type":"option","char":"b","description":"Which benchmark to run"},"delay":{"name":"delay","type":"option","char":"d","description":"delay between runs (s)","default":30}},"args":[{"name":"baseurl","description":"Base URL","required":false}]},"run-tests":{"id":"run-tests","description":"Run test suites","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{"coverage":{"name":"coverage","type":"boolean","char":"c","description":"Coverage","allowNo":false},"forever":{"name":"forever","type":"boolean","char":"f","description":"Run forever till failure","allowNo":false}},"args":[{"name":"package","description":"which package to run tests for"}]},"scheduler":{"id":"scheduler","description":"Run the Saltcorn scheduler","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{"verbose":{"name":"verbose","type":"boolean","char":"v","description":"Verbose","allowNo":false}},"args":[]},"serve":{"id":"serve","description":"Start the Saltcorn server","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{"port":{"name":"port","type":"option","char":"p","description":"port","default":3000},"verbose":{"name":"verbose","type":"boolean","char":"v","description":"Verbose","allowNo":false},"watchReaper":{"name":"watchReaper","type":"boolean","char":"r","description":"Watch reaper","allowNo":false},"addschema":{"name":"addschema","type":"boolean","char":"a","description":"Add schema if missing","allowNo":false},"nomigrate":{"name":"nomigrate","type":"boolean","char":"n","description":"No migrations","allowNo":false},"noscheduler":{"name":"noscheduler","type":"boolean","char":"s","description":"No scheduler","allowNo":false}},"args":[]},"set-cfg":{"id":"set-cfg","description":"Set a configuration value","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{"tenant":{"name":"tenant","type":"option","char":"t","description":"tenant"},"plugin":{"name":"plugin","type":"option","char":"p","description":"plugin"}},"args":[{"name":"key","description":"Configuration key","required":true},{"name":"value","description":"Configuration value (JSON or string)","required":true}]},"setup-benchmark":{"id":"setup-benchmark","description":"Setup an instance for benchmarking","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{"tenant":{"name":"tenant","type":"option","char":"t","description":"tenant"}},"args":[]},"setup":{"id":"setup","description":"Set up a new system\n...\nThis will attempt to install or connect a database, and set up a \nconfiguration file\n","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{"coverage":{"name":"coverage","type":"boolean","char":"c","description":"Coverage","allowNo":false}},"args":[]},"test-plugin":{"id":"test-plugin","description":"Test a plugin\n...\nExtra documentation goes here\n","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"path","description":"path to plugin package","required":true}]},"transform-field":{"id":"transform-field","description":"transform an existing field by applying a calculated expression","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"expression","description":"expression to calculate field","required":true},{"name":"field","description":"field name","required":true},{"name":"table","description":"table name","required":true},{"name":"tenant","description":"tenant name","required":false}]}}}
+{"version":"0.6.1","commands":{"add-schema":{"id":"add-schema","description":"Add Saltcorn schema to existing database","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"backup":{"id":"backup","description":"Backup the PostgreSQL database to a file with pg_dump or zip","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{"output":{"name":"output","type":"option","char":"o","description":"output filename"},"tenant":{"name":"tenant","type":"option","char":"t","description":"tenant"},"zip":{"name":"zip","type":"boolean","char":"z","description":"zip format","allowNo":false}},"args":[]},"create-tenant":{"id":"create-tenant","description":"Create a tenant","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{"email":{"name":"email","type":"option","char":"e","description":"Email of owner of tenant"},"description":{"name":"description","type":"option","char":"d","description":"Description of tenant"}},"args":[{"name":"tenant","description":"Tenant subdomain to create","required":true}]},"create-user":{"id":"create-user","description":"Create a new user","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{"admin":{"name":"admin","type":"boolean","char":"a","description":"Admin user","allowNo":false},"tenant":{"name":"tenant","type":"option","char":"t","description":"tenant"},"email":{"name":"email","type":"option","char":"e","description":"email"},"role":{"name":"role","type":"option","char":"r","description":"role"},"password":{"name":"password","type":"option","char":"p","description":"password"}},"args":[]},"fixtures":{"id":"fixtures","description":"Load fixtures for testing\n...\nThis manual step it is never required for users and rarely required for developers\n","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{"reset":{"name":"reset","type":"boolean","char":"r","description":"Also reset schema","allowNo":false}},"args":[]},"info":{"id":"info","description":"Show paths\n...\nShow configuration and file store paths\n","pluginName":"@saltcorn/cli","pluginType":"core","aliases":["paths"],"flags":{"json":{"name":"json","type":"boolean","char":"j","description":"json format","allowNo":false}},"args":[]},"install-pack":{"id":"install-pack","description":"Install a pack","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{"tenant":{"name":"tenant","type":"option","char":"t","description":"tenant"},"name":{"name":"name","type":"option","char":"n","description":"Pack name in store"},"file":{"name":"file","type":"option","char":"f","description":"File with pack JSON"}},"args":[]},"install-plugin":{"id":"install-plugin","description":"Install a plugin","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{"tenant":{"name":"tenant","type":"option","char":"t","description":"tenant"},"name":{"name":"name","type":"option","char":"n","description":"Plugin name in store"},"directory":{"name":"directory","type":"option","char":"d","description":"Directory with local plugin"}},"args":[]},"list-tenants":{"id":"list-tenants","description":"List tenants in CSV format","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"localize-plugin":{"id":"localize-plugin","description":"Convert plugin to local plugin","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{"tenant":{"name":"tenant","type":"option","char":"t","description":"tenant"}},"args":[{"name":"plugin","description":"Current plugin name","required":true},{"name":"path","description":"path to local plugin","required":true}]},"make-migration":{"id":"make-migration","description":"Create a new blank Database structure migration file.\nThese migrations update database structure.\nYou should not normally need to run this\nunless you are a developer.\n","usage":"make-migration","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"migrate":{"id":"migrate","description":"Run Database structure migrations\n...\nNOTE!\n- Please stop Saltcorn before run DB migrations.\n- Please make db backup before migration.\n- There are no way to rollback migration if you doesn't make backup.\n\nThis is not normally required as migrations will be run when the server starts.\nHowever, this command may be useful if you are running multiple application\nservers and need to control when the migrations are run.\n","usage":"saltcorn migrate","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"plugins":{"id":"plugins","description":"List and upgrade plugins for tenants\n...\nExtra documentation goes here\n","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"examples":["plugins -v - verbose output of commands","plugins -u -d - dry-run for plugin update","plugins -u -f - force plugin update"],"flags":{"upgrade":{"name":"upgrade","type":"boolean","char":"u","description":"Upgrade","allowNo":false},"dryRun":{"name":"dryRun","type":"boolean","char":"d","description":"Upgrade dry-run","allowNo":false},"verbose":{"name":"verbose","type":"boolean","char":"v","description":"Verbose output","allowNo":false},"force":{"name":"force","type":"boolean","char":"f","description":"Force update","allowNo":false},"name":{"name":"name","type":"option","char":"n","description":"Plugin name"}},"args":[]},"release":{"id":"release","description":"Release a new saltcorn version","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"version","description":"New version number","required":true}]},"reset-schema":{"id":"reset-schema","description":"Reset the database\n...\nThis will delete all existing information\n","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{"force":{"name":"force","type":"boolean","char":"f","description":"force","allowNo":false},"tenant":{"name":"tenant","type":"option","char":"t","description":"tenant"}},"args":[]},"restore":{"id":"restore","description":"Restore a previously backed up database (zip or sqlc format)","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{"tenant":{"name":"tenant","type":"option","char":"t","description":"tenant"}},"args":[{"name":"file","description":"backup file to restore","required":true}]},"rm-tenant":{"id":"rm-tenant","description":"Remove a tenant","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"tenant","description":"Tenant to remove","required":true}]},"run-benchmark":{"id":"run-benchmark","description":"Run benchmark","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{"token":{"name":"token","type":"option","char":"t","description":"API Token for reporting results"},"benchmark":{"name":"benchmark","type":"option","char":"b","description":"Which benchmark to run"},"delay":{"name":"delay","type":"option","char":"d","description":"delay between runs (s)","default":30}},"args":[{"name":"baseurl","description":"Base URL","required":false}]},"run-tests":{"id":"run-tests","description":"Run test suites","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{"coverage":{"name":"coverage","type":"boolean","char":"c","description":"Coverage","allowNo":false},"testFilter":{"name":"testFilter","type":"option","char":"t","description":"Filter tests by suite or test name"},"watch":{"name":"watch","type":"boolean","description":"Watch files for changes and rerun tests related to changed files.","allowNo":false},"watchAll":{"name":"watchAll","type":"boolean","description":"Watch files for changes and rerun all tests.","allowNo":false}},"args":[{"name":"package","description":"which package to run tests for"}]},"scheduler":{"id":"scheduler","description":"Run the Saltcorn scheduler","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{"verbose":{"name":"verbose","type":"boolean","char":"v","description":"Verbose","allowNo":false}},"args":[]},"serve":{"id":"serve","description":"Start the Saltcorn server","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{"port":{"name":"port","type":"option","char":"p","description":"port","default":3000},"verbose":{"name":"verbose","type":"boolean","char":"v","description":"Verbose","allowNo":false},"watchReaper":{"name":"watchReaper","type":"boolean","char":"r","description":"Watch reaper","allowNo":false},"addschema":{"name":"addschema","type":"boolean","char":"a","description":"Add schema if missing","allowNo":false},"nomigrate":{"name":"nomigrate","type":"boolean","char":"n","description":"No migrations","allowNo":false},"noscheduler":{"name":"noscheduler","type":"boolean","char":"s","description":"No scheduler","allowNo":false}},"args":[]},"set-cfg":{"id":"set-cfg","description":"Set a configuration value","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{"tenant":{"name":"tenant","type":"option","char":"t","description":"tenant"},"plugin":{"name":"plugin","type":"option","char":"p","description":"plugin"}},"args":[{"name":"key","description":"Configuration key","required":true},{"name":"value","description":"Configuration value (JSON or string)","required":true}]},"setup-benchmark":{"id":"setup-benchmark","description":"Setup an instance for benchmarking","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{"tenant":{"name":"tenant","type":"option","char":"t","description":"tenant"}},"args":[]},"setup":{"id":"setup","description":"Set up a new system\n...\nThis will attempt to install or connect a database, and set up a \nconfiguration file\n","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{"coverage":{"name":"coverage","type":"boolean","char":"c","description":"Coverage","allowNo":false}},"args":[]},"test-plugin":{"id":"test-plugin","description":"Test a plugin\n...\nExtra documentation goes here\n","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"path","description":"path to plugin package","required":true}]},"transform-field":{"id":"transform-field","description":"transform an existing field by applying a calculated expression","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"expression","description":"expression to calculate field","required":true},{"name":"field","description":"field name","required":true},{"name":"table","description":"table name","required":true},{"name":"tenant","description":"tenant name","required":false}]}}}

package/package.json

@@ -2,18 +2,18 @@
   "name": "@saltcorn/cli",
   "description": "Command-line interface for Saltcorn, open-source no-code platform",
   "homepage": "https://saltcorn.com",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "author": "Tom Nielsen @glutamate",
   "bin": {
     "saltcorn": "./bin/saltcorn"
   },
   "bugs": "https://github.com/saltcorn/saltcorn/issues",
   "dependencies": {
-    "@oclif/command": "^1.8.0",
-    "@oclif/config": "^1.17.0",
-    "@oclif/plugin-help": "^3.2.3",
-    "@saltcorn/data": "0.6.0",
-    "@saltcorn/server": "0.6.0",
+    "@oclif/command": "^1.8.3",
+    "@oclif/config": "^1.17.1",
+    "@oclif/plugin-help": "^3.2.5",
+    "@saltcorn/data": "0.6.1",
+    "@saltcorn/server": "0.6.1",
     "cli-ux": "^5.6.3",
     "contractis": "^0.1.0",
     "dateformat": "^3.0.3",
@@ -21,7 +21,7 @@
     "js-yaml": "^4.1.0",
     "node-fetch": "2.6.2",
     "sudo": "^1.0.3",
-    "systeminformation": "^5.9.8",
+    "systeminformation": "^5.9.15",
     "tcp-port-used": "^1.0.2",
     "wrk": "^1.2.1"
   },

package/src/commands/add-schema.js

@@ -1,7 +1,19 @@
+/**
+ * @category saltcorn-cli
+ * @module commands/add-schema
+ */
 const { Command, flags } = require("@oclif/command");
 const { cli } = require("cli-ux");
 
+/**
+ * AddSchemaCommand Class
+ * @extends oclif.Command
+ * @category saltcorn-cli
+ */
 class AddSchemaCommand extends Command {
+  /**
+   * @returns {Promise<void>}
+   */
   async run() {
     const reset = require("@saltcorn/data/db/reset_schema");
     await reset(true);
@@ -10,6 +22,9 @@ class AddSchemaCommand extends Command {
   }
 }
 
+/**
+ * @type {string}
+ */
 AddSchemaCommand.description = `Add Saltcorn schema to existing database`;
 
 module.exports = AddSchemaCommand;

package/src/commands/backup.js

@@ -1,3 +1,7 @@
+/**
+ * @category saltcorn-cli
+ * @module commands/backup
+ */
 const { Command, flags } = require("@oclif/command");
 const { execSync } = require("child_process");
 const dateFormat = require("dateformat");
@@ -11,7 +15,15 @@ const pgdb = connobj.database;
 
 var default_filenm = `${day}-${pgdb}-${os.hostname}.sqlc`;
 
+/**
+ * BackupCommand Class
+ * @extends oclif.Command
+ * @category saltcorn-cli
+ */
 class BackupCommand extends Command {
+  /**
+   * @returns {Promise<void>}
+   */
   async run() {
     const { flags } = this.parse(BackupCommand);
 
@@ -49,8 +61,14 @@ class BackupCommand extends Command {
   }
 }
 
+/**
+ * @type {string}
+ */
 BackupCommand.description = `Backup the PostgreSQL database to a file with pg_dump or zip`;
 
+/**
+ * @type {object}
+ */
 BackupCommand.flags = {
   output: flags.string({
     char: "o",

package/src/commands/create-tenant.js

@@ -1,10 +1,22 @@
+/**
+ * @category saltcorn-cli
+ * @module commands/create-tenant
+ */
 const { Command, flags } = require("@oclif/command");
 
 //const {
 //  getConfig,
 //} = require("@saltcorn/data/models/config");
 
+/**
+ * CreateTenantCommand Class
+ * @extends oclif.Command
+ * @category saltcorn-cli
+ */
 class CreateTenantCommand extends Command {
+  /**
+   * @returns {Promise<void>}
+   */
   async run() {
     const { args } = this.parse(CreateTenantCommand);
     const { flags } = this.parse(CreateTenantCommand);
@@ -26,12 +38,21 @@ class CreateTenantCommand extends Command {
   }
 }
 
+/**
+ * @type {object}
+ */
 CreateTenantCommand.args = [
   { name: "tenant", required: true, description: "Tenant subdomain to create" },
 ];
 
+/**
+ * @type {string}
+ */
 CreateTenantCommand.description = `Create a tenant`;
 
+/**
+ * @type {object}
+ */
 CreateTenantCommand.flags = {
   email: flags.string({
     name: "url",

package/src/commands/create-user.js

@@ -1,8 +1,20 @@
+/**
+ * @category saltcorn-cli
+ * @module commands/create-user
+ */
 const { Command, flags } = require("@oclif/command");
 const { cli } = require("cli-ux");
 const { maybe_as_tenant } = require("../common");
 
+/**
+ * CreateUserCommand Class
+ * @extends oclif.Command
+ * @category saltcorn-cli
+ */
 class CreateUserCommand extends Command {
+  /**
+   * @returns {Promise<void>}
+   */
   async run() {
     const User = require("@saltcorn/data/models/user");
     const { flags } = this.parse(CreateUserCommand);
@@ -31,8 +43,14 @@ class CreateUserCommand extends Command {
   }
 }
 
+/**
+ * @type {string}
+ */
 CreateUserCommand.description = `Create a new user`;
 
+/**
+ * @type {object}
+ */
 CreateUserCommand.flags = {
   admin: flags.boolean({ char: "a", description: "Admin user" }),
   tenant: flags.string({

package/src/commands/fixtures.js

@@ -1,6 +1,18 @@
+/**
+ * @category saltcorn-cli
+ * @module commands/fixtures
+ */
 const { Command, flags } = require("@oclif/command");
 
+/**
+ * FixturesCommand Class
+ * @extends oclif.Command
+ * @category saltcorn-cli
+ */
 class FixturesCommand extends Command {
+  /**
+   * @returns {Promise<void>}
+   */
   async run() {
     const fixtures = require("@saltcorn/data/db/fixtures");
     const reset = require("@saltcorn/data/db/reset_schema");
@@ -14,11 +26,17 @@ class FixturesCommand extends Command {
   }
 }
 
+/**
+ * @type {string}
+ */
 FixturesCommand.description = `Load fixtures for testing
 ...
 This manual step it is never required for users and rarely required for developers
 `;
 
+/**
+ * @type {object}
+ */
 FixturesCommand.flags = {
   reset: flags.boolean({ char: "r", description: "Also reset schema" }),
 };

package/src/commands/info.js

@@ -1,3 +1,7 @@
+/**
+ * @category saltcorn-cli
+ * @module commands/info
+ */
 const { Command, flags } = require("@oclif/command");
 const {
   configFilePath,
@@ -6,14 +10,31 @@ const {
 const { dump } = require("js-yaml");
 const packagejson = require("../../package.json");
 
-
+/**
+ * 
+ * @param {object[]} results 
+ * @param {boolean} json 
+ * @returns {void}
+ */
 const print_it = (results, json) => {
   if (json) console.log(JSON.stringify(results, null, 2));
   else console.log(dump(results, { lineWidth: process.stdout.columns }));
 };
 
+/**
+ * InfoCommand Class
+ * @extends oclif.Command
+ * @category saltcorn-cli
+ */
 class InfoCommand extends Command {
+  /**
+   * @type {string[]}
+   */
   static aliases = ["paths"];
+
+  /**
+   * @returns {Promise<void>}
+   */
   async run() {
     const { flags } = this.parse(InfoCommand);
     const db = require("@saltcorn/data/db");
@@ -33,18 +54,32 @@ class InfoCommand extends Command {
       res.configuration = conn;
       res.connectionError = e.message;
     }
-
+    res.environmentVariables = {};
+    const envVars = "DATABASE_URL SQLITE_FILEPATH PGDATABASE PGUSER PGHOST PGPORT PGPASSWORD PGDATABASE SALTCORN_SESSION_SECRET SALTCORN_MULTI_TENANT SALTCORN_FILE_STORE SALTCORN_DEFAULT_SCHEMA SALTCORN_FIXED_CONFIGURATION SALTCORN_INHERIT_CONFIGURATION SALTCORN_SERVE_ADDITIONAL_DIR SALTCORN_NWORKERS SALTCORN_DISABLE_UPGRADE PUPPETEER_CHROMIUM_BIN".split(
+      " "
+    );
+    envVars.forEach((v) => {
+      if (process.env[v]) res.environmentVariables[v] = process.env[v];
+      else res.environmentVariables[v] = "";
+    });
     print_it(res, flags.json);
     this.exit(0);
   }
 }
 
+/**
+ * @type {string}
+ */
 InfoCommand.description = `Show paths
 ...
 Show configuration and file store paths
 `;
 
+/**
+ * @type {object}
+ */
 InfoCommand.flags = {
   json: flags.boolean({ char: "j", description: "json format" }),
 };
+
 module.exports = InfoCommand;

package/src/commands/install-pack.js

@@ -1,8 +1,20 @@
+/**
+ * @category saltcorn-cli
+ * @module commands/install-pack
+ */
 const { Command, flags } = require("@oclif/command");
 const { maybe_as_tenant } = require("../common");
 const fs = require("fs");
 
+/**
+ * InstallPackCommand Class
+ * @extends oclif.Command
+ * @category saltcorn-cli
+ */
 class InstallPackCommand extends Command {
+  /**
+   * @returns {Promise<void>}
+   */
   async run() {
     const { flags } = this.parse(InstallPackCommand);
     const {
@@ -49,8 +61,14 @@ class InstallPackCommand extends Command {
   }
 }
 
+/**
+ * @type {string}
+ */
 InstallPackCommand.description = `Install a pack`;
 
+/**
+ * @type {object}
+ */
 InstallPackCommand.flags = {
   tenant: flags.string({
     char: "t",

package/src/commands/install-plugin.js

@@ -1,9 +1,21 @@
+/**
+ * @category saltcorn-cli
+ * @module commands/install-plugin
+ */
 const { Command, flags } = require("@oclif/command");
 const { maybe_as_tenant } = require("../common");
 const fs = require("fs");
 const path = require("path");
 
+/**
+ * InstallPluginCommand Class
+ * @extends oclif.Command
+ * @category saltcorn-cli
+ */
 class InstallPluginCommand extends Command {
+  /**
+   * @returns {Promise<void>}
+   */
   async run() {
     const { flags } = this.parse(InstallPluginCommand);
     const {
@@ -59,8 +71,14 @@ class InstallPluginCommand extends Command {
   }
 }
 
+/**
+ * @type {string}
+ */
 InstallPluginCommand.description = `Install a plugin`;
 
+/**
+ * @type {object}
+ */
 InstallPluginCommand.flags = {
   tenant: flags.string({
     char: "t",

package/src/commands/list-tenants.js

@@ -1,6 +1,19 @@
+/**
+ * @category saltcorn-cli
+ * @module commands/list-tenants
+ */
 const { Command, flags } = require("@oclif/command");
 
+
+/**
+ * ListTenantsCommand Class
+ * @extends oclif.Command
+ * @category saltcorn-cli
+ */
 class ListTenantsCommand extends Command {
+  /**
+   * @returns {Promise<void>}
+   */
   async run() {
     const { getAllTenants } = require("@saltcorn/data/models/tenant");
     const db = require("@saltcorn/data/db");
@@ -21,9 +34,15 @@ class ListTenantsCommand extends Command {
   }
 }
 
+/**
+ * @type {string}
+ */
 ListTenantsCommand.description = `List tenants in CSV format`;
 
 // TODO Extra help here
+/**
+ * @type {string}
+ */
 ListTenantsCommand.help= "Extra help here"
 
 module.exports = ListTenantsCommand;

package/src/commands/localize-plugin.js

@@ -1,21 +1,36 @@
+/**
+ * @category saltcorn-cli
+ * @module commands/localize-plugin
+ */
 const { Command, flags } = require("@oclif/command");
+const { maybe_as_tenant } = require("../common");
 
+/**
+ * LocalizePluginCommand Class
+ * @extends oclif.Command
+ * @category saltcorn-cli
+ */
 class LocalizePluginCommand extends Command {
+  /**
+   * @returns {Promise<void>}
+   */
   async run() {
     const db = require("@saltcorn/data/db");
     const Plugin = require("@saltcorn/data/models/plugin");
-    const { args } = this.parse(LocalizePluginCommand);
-    const plugin = await Plugin.findOne({ name: args.plugin });
-    if (!plugin || plugin.source === "local") {
-      console.error("Localisable plugin not found");
-      this.exit(1);
-    }
+    const { args, flags } = this.parse(LocalizePluginCommand);
+    await maybe_as_tenant(flags.tenant, async () => {
+      const plugin = await Plugin.findOne({ name: args.plugin });
+      if (!plugin || plugin.source === "local") {
+        console.error("Localisable plugin not found");
+        this.exit(1);
+      }
 
-    plugin.name = plugin.source === "npm" ? plugin.location : args.plugin;
-    plugin.source = "local";
-    plugin.location = args.path;
-    await plugin.upsert();
-    console.log("Plugin saved", plugin);
+      plugin.name = plugin.source === "npm" ? plugin.location : args.plugin;
+      plugin.source = "local";
+      plugin.location = args.path;
+      await plugin.upsert();
+      console.log("Plugin saved", plugin);
+    });
     this.exit(0);
   }
 }
@@ -25,8 +40,19 @@ LocalizePluginCommand.args = [
   { name: "path", required: true, description: "path to local plugin" },
 ];
 
+/**
+ * @type {string}
+ */
 LocalizePluginCommand.description = `Convert plugin to local plugin`;
 
-LocalizePluginCommand.flags = {};
+/**
+ * @type {object}
+ */
+LocalizePluginCommand.flags = {
+  tenant: flags.string({
+    char: "t",
+    description: "tenant",
+  }),
+};
 
 module.exports = LocalizePluginCommand;

package/src/commands/make-migration.js

@@ -1,24 +1,45 @@
+/**
+ * @category saltcorn-cli
+ * @module commands/make-migration
+ */
 const { Command, flags } = require("@oclif/command");
 
+/**
+ * MigrationCommand Class
+ * @extends oclif.Command
+ * @category saltcorn-cli
+ */
 class MigrationCommand extends Command {
+  /**
+   * @returns {Promise<void>}
+   */
   async run() {
     const { create_blank_migration } = require("@saltcorn/data/migrate");
     await create_blank_migration();
   }
 }
 
+/**
+ * @type {string}
+ */
 MigrationCommand.description = `Create a new blank Database structure migration file.
 These migrations update database structure.
 You should not normally need to run this
 unless you are a developer.
 `;
 
+/**
+ * @type {string}
+ */
 MigrationCommand.help = `Create a new blank Database structure migration file.
 These migrations update database structure.
 You should not normally need to run this
 unless you are a developer.
 `;
 
+/**
+ * @type {string}
+ */
 MigrationCommand.usage = "make-migration";
 
 module.exports = MigrationCommand;

package/src/commands/migrate.js

@@ -1,8 +1,21 @@
+/**
+ * @category saltcorn-cli
+ * @module commands/migrate
+ */
 const { Command, flags } = require("@oclif/command");
 const db = require("@saltcorn/data/db");
 const { eachTenant } = require("@saltcorn/data/models/tenant");
 // todo add dryrun mode
+
+/**
+ * MigrateCommand Class
+ * @extends oclif.Command
+ * @category saltcorn-cli
+ */
 class MigrateCommand extends Command {
+  /**
+   * @returns {Promise<void>}
+   */
   async run() {
     const { migrate } = require("@saltcorn/data/migrate");
     await eachTenant(async () => {
@@ -14,6 +27,9 @@ class MigrateCommand extends Command {
   }
 }
 
+/**
+ * @type {string}
+ */
 MigrateCommand.description = `Run Database structure migrations
 ...
 NOTE!
@@ -26,6 +42,9 @@ However, this command may be useful if you are running multiple application
 servers and need to control when the migrations are run.
 `;
 
+/**
+ * @type {string}
+ */
 MigrateCommand.help = `Run Database structure migrations.
 Command goes in circle via all tenants and applies all unapplyed database structure migrations.
 
@@ -35,7 +54,9 @@ NOTE!
 - There are no way to rollback migration if you doesn't make backup.
 `;
 
-
+/**
+ * @type {string}
+ */
 MigrateCommand.usage = "saltcorn migrate";
 
 module.exports = MigrateCommand;