@saltcorn/cli 0.7.2-beta.0 → 0.7.2-beta.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +244 -49
- package/oclif.manifest.json +1 -1
- package/package.json +10 -7
- package/src/commands/add-schema.js +23 -1
- package/src/commands/backup.js +7 -3
- package/src/commands/create-user.js +14 -8
- package/src/commands/delete-tenants.js +24 -20
- package/src/commands/delete-user.js +105 -0
- package/src/commands/get-cfg.js +63 -0
- package/src/commands/modify-user.js +163 -0
- package/src/commands/release.js +20 -9
- package/src/commands/reset-schema.js +11 -2
- package/src/commands/restore.js +5 -0
- package/src/commands/rm-tenant.js +39 -6
- package/src/commands/run-tests.js +44 -16
- package/src/commands/setup.js +48 -23
- package/src/common.js +13 -5
- package/src/index.js +9 -2
- package/CHANGELOG.md +0 -8
package/README.md
CHANGED
|
@@ -20,7 +20,7 @@ $ npm install -g @saltcorn/cli
|
|
|
20
20
|
$ saltcorn COMMAND
|
|
21
21
|
running command...
|
|
22
22
|
$ saltcorn (-v|--version|version)
|
|
23
|
-
@saltcorn/cli/0.7.2-beta.
|
|
23
|
+
@saltcorn/cli/0.7.2-beta.10 darwin-arm64 node-v16.15.1
|
|
24
24
|
$ saltcorn --help [COMMAND]
|
|
25
25
|
USAGE
|
|
26
26
|
$ saltcorn COMMAND
|
|
@@ -37,7 +37,9 @@ USAGE
|
|
|
37
37
|
* [`saltcorn create-tenant TENANT`](#saltcorn-create-tenant-tenant)
|
|
38
38
|
* [`saltcorn create-user`](#saltcorn-create-user)
|
|
39
39
|
* [`saltcorn delete-tenants`](#saltcorn-delete-tenants)
|
|
40
|
+
* [`saltcorn delete-user USER_EMAIL`](#saltcorn-delete-user-user_email)
|
|
40
41
|
* [`saltcorn fixtures`](#saltcorn-fixtures)
|
|
42
|
+
* [`saltcorn get-cfg KEY`](#saltcorn-get-cfg-key)
|
|
41
43
|
* [`saltcorn help [COMMAND]`](#saltcorn-help-command)
|
|
42
44
|
* [`saltcorn info`](#saltcorn-info)
|
|
43
45
|
* [`saltcorn install-pack`](#saltcorn-install-pack)
|
|
@@ -46,11 +48,17 @@ USAGE
|
|
|
46
48
|
* [`saltcorn localize-plugin PLUGIN PATH`](#saltcorn-localize-plugin-plugin-path)
|
|
47
49
|
* [`saltcorn make-migration`](#saltcorn-make-migration)
|
|
48
50
|
* [`saltcorn saltcorn migrate`](#saltcorn-saltcorn-migrate)
|
|
51
|
+
* [`saltcorn modify-user USER_EMAIL`](#saltcorn-modify-user-user_email)
|
|
49
52
|
* [`saltcorn plugins`](#saltcorn-plugins)
|
|
53
|
+
* [`saltcorn plugins:inspect PLUGIN...`](#saltcorn-pluginsinspect-plugin)
|
|
54
|
+
* [`saltcorn plugins:install PLUGIN...`](#saltcorn-pluginsinstall-plugin)
|
|
55
|
+
* [`saltcorn plugins:link PLUGIN`](#saltcorn-pluginslink-plugin)
|
|
56
|
+
* [`saltcorn plugins:uninstall PLUGIN...`](#saltcorn-pluginsuninstall-plugin)
|
|
57
|
+
* [`saltcorn plugins:update`](#saltcorn-pluginsupdate)
|
|
50
58
|
* [`saltcorn release VERSION`](#saltcorn-release-version)
|
|
51
59
|
* [`saltcorn reset-schema`](#saltcorn-reset-schema)
|
|
52
60
|
* [`saltcorn restore FILE`](#saltcorn-restore-file)
|
|
53
|
-
* [`saltcorn rm-tenant
|
|
61
|
+
* [`saltcorn rm-tenant`](#saltcorn-rm-tenant)
|
|
54
62
|
* [`saltcorn run-benchmark [BASEURL]`](#saltcorn-run-benchmark-baseurl)
|
|
55
63
|
* [`saltcorn run-tests [PACKAGE]`](#saltcorn-run-tests-package)
|
|
56
64
|
* [`saltcorn scheduler`](#saltcorn-scheduler)
|
|
@@ -68,9 +76,12 @@ Add Saltcorn schema to existing database
|
|
|
68
76
|
```
|
|
69
77
|
USAGE
|
|
70
78
|
$ saltcorn add-schema
|
|
79
|
+
|
|
80
|
+
OPTIONS
|
|
81
|
+
-f, --force force command execution
|
|
71
82
|
```
|
|
72
83
|
|
|
73
|
-
_See code: [src/commands/add-schema.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.
|
|
84
|
+
_See code: [src/commands/add-schema.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/add-schema.js)_
|
|
74
85
|
|
|
75
86
|
## `saltcorn backup`
|
|
76
87
|
|
|
@@ -86,7 +97,7 @@ OPTIONS
|
|
|
86
97
|
-z, --zip zip format
|
|
87
98
|
```
|
|
88
99
|
|
|
89
|
-
_See code: [src/commands/backup.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.
|
|
100
|
+
_See code: [src/commands/backup.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/backup.js)_
|
|
90
101
|
|
|
91
102
|
## `saltcorn configuration-check`
|
|
92
103
|
|
|
@@ -100,7 +111,7 @@ OPTIONS
|
|
|
100
111
|
-t, --tenant=tenant tenant
|
|
101
112
|
```
|
|
102
113
|
|
|
103
|
-
_See code: [src/commands/configuration-check.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.
|
|
114
|
+
_See code: [src/commands/configuration-check.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/configuration-check.js)_
|
|
104
115
|
|
|
105
116
|
## `saltcorn create-tenant TENANT`
|
|
106
117
|
|
|
@@ -118,7 +129,7 @@ OPTIONS
|
|
|
118
129
|
-e, --email=email Email of owner of tenant
|
|
119
130
|
```
|
|
120
131
|
|
|
121
|
-
_See code: [src/commands/create-tenant.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.
|
|
132
|
+
_See code: [src/commands/create-tenant.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/create-tenant.js)_
|
|
122
133
|
|
|
123
134
|
## `saltcorn create-user`
|
|
124
135
|
|
|
@@ -136,7 +147,7 @@ OPTIONS
|
|
|
136
147
|
-t, --tenant=tenant tenant
|
|
137
148
|
```
|
|
138
149
|
|
|
139
|
-
_See code: [src/commands/create-user.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.
|
|
150
|
+
_See code: [src/commands/create-user.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/create-user.js)_
|
|
140
151
|
|
|
141
152
|
## `saltcorn delete-tenants`
|
|
142
153
|
|
|
@@ -147,7 +158,28 @@ USAGE
|
|
|
147
158
|
$ saltcorn delete-tenants
|
|
148
159
|
```
|
|
149
160
|
|
|
150
|
-
_See code: [src/commands/delete-tenants.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.
|
|
161
|
+
_See code: [src/commands/delete-tenants.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/delete-tenants.js)_
|
|
162
|
+
|
|
163
|
+
## `saltcorn delete-user USER_EMAIL`
|
|
164
|
+
|
|
165
|
+
Delete user.
|
|
166
|
+
|
|
167
|
+
```
|
|
168
|
+
USAGE
|
|
169
|
+
$ saltcorn delete-user USER_EMAIL
|
|
170
|
+
|
|
171
|
+
ARGUMENTS
|
|
172
|
+
USER_EMAIL User to delete
|
|
173
|
+
|
|
174
|
+
OPTIONS
|
|
175
|
+
-f, --force force command execution
|
|
176
|
+
-t, --tenant=tenant tenant
|
|
177
|
+
|
|
178
|
+
DESCRIPTION
|
|
179
|
+
Command deletes the user specified by USER_EMAIL.
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
_See code: [src/commands/delete-user.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/delete-user.js)_
|
|
151
183
|
|
|
152
184
|
## `saltcorn fixtures`
|
|
153
185
|
|
|
@@ -166,7 +198,25 @@ DESCRIPTION
|
|
|
166
198
|
This manual step it is never required for users and rarely required for developers
|
|
167
199
|
```
|
|
168
200
|
|
|
169
|
-
_See code: [src/commands/fixtures.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.
|
|
201
|
+
_See code: [src/commands/fixtures.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/fixtures.js)_
|
|
202
|
+
|
|
203
|
+
## `saltcorn get-cfg KEY`
|
|
204
|
+
|
|
205
|
+
Get a configuration value
|
|
206
|
+
|
|
207
|
+
```
|
|
208
|
+
USAGE
|
|
209
|
+
$ saltcorn get-cfg KEY
|
|
210
|
+
|
|
211
|
+
ARGUMENTS
|
|
212
|
+
KEY Configuration key
|
|
213
|
+
|
|
214
|
+
OPTIONS
|
|
215
|
+
-p, --plugin=plugin plugin
|
|
216
|
+
-t, --tenant=tenant tenant
|
|
217
|
+
```
|
|
218
|
+
|
|
219
|
+
_See code: [src/commands/get-cfg.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/get-cfg.js)_
|
|
170
220
|
|
|
171
221
|
## `saltcorn help [COMMAND]`
|
|
172
222
|
|
|
@@ -183,7 +233,7 @@ OPTIONS
|
|
|
183
233
|
--all see all commands in CLI
|
|
184
234
|
```
|
|
185
235
|
|
|
186
|
-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.
|
|
236
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.18/src/commands/help.ts)_
|
|
187
237
|
|
|
188
238
|
## `saltcorn info`
|
|
189
239
|
|
|
@@ -204,7 +254,7 @@ ALIASES
|
|
|
204
254
|
$ saltcorn paths
|
|
205
255
|
```
|
|
206
256
|
|
|
207
|
-
_See code: [src/commands/info.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.
|
|
257
|
+
_See code: [src/commands/info.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/info.js)_
|
|
208
258
|
|
|
209
259
|
## `saltcorn install-pack`
|
|
210
260
|
|
|
@@ -220,7 +270,7 @@ OPTIONS
|
|
|
220
270
|
-t, --tenant=tenant tenant
|
|
221
271
|
```
|
|
222
272
|
|
|
223
|
-
_See code: [src/commands/install-pack.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.
|
|
273
|
+
_See code: [src/commands/install-pack.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/install-pack.js)_
|
|
224
274
|
|
|
225
275
|
## `saltcorn install-plugin`
|
|
226
276
|
|
|
@@ -236,7 +286,7 @@ OPTIONS
|
|
|
236
286
|
-t, --tenant=tenant tenant
|
|
237
287
|
```
|
|
238
288
|
|
|
239
|
-
_See code: [src/commands/install-plugin.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.
|
|
289
|
+
_See code: [src/commands/install-plugin.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/install-plugin.js)_
|
|
240
290
|
|
|
241
291
|
## `saltcorn list-tenants`
|
|
242
292
|
|
|
@@ -247,7 +297,7 @@ USAGE
|
|
|
247
297
|
$ saltcorn list-tenants
|
|
248
298
|
```
|
|
249
299
|
|
|
250
|
-
_See code: [src/commands/list-tenants.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.
|
|
300
|
+
_See code: [src/commands/list-tenants.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/list-tenants.js)_
|
|
251
301
|
|
|
252
302
|
## `saltcorn localize-plugin PLUGIN PATH`
|
|
253
303
|
|
|
@@ -265,7 +315,7 @@ OPTIONS
|
|
|
265
315
|
-t, --tenant=tenant tenant
|
|
266
316
|
```
|
|
267
317
|
|
|
268
|
-
_See code: [src/commands/localize-plugin.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.
|
|
318
|
+
_See code: [src/commands/localize-plugin.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/localize-plugin.js)_
|
|
269
319
|
|
|
270
320
|
## `saltcorn make-migration`
|
|
271
321
|
|
|
@@ -281,7 +331,7 @@ DESCRIPTION
|
|
|
281
331
|
unless you are a developer.
|
|
282
332
|
```
|
|
283
333
|
|
|
284
|
-
_See code: [src/commands/make-migration.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.
|
|
334
|
+
_See code: [src/commands/make-migration.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/make-migration.js)_
|
|
285
335
|
|
|
286
336
|
## `saltcorn saltcorn migrate`
|
|
287
337
|
|
|
@@ -303,34 +353,174 @@ DESCRIPTION
|
|
|
303
353
|
servers and need to control when the migrations are run.
|
|
304
354
|
```
|
|
305
355
|
|
|
306
|
-
_See code: [src/commands/migrate.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.
|
|
356
|
+
_See code: [src/commands/migrate.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/migrate.js)_
|
|
357
|
+
|
|
358
|
+
## `saltcorn modify-user USER_EMAIL`
|
|
359
|
+
|
|
360
|
+
Modify (update) user.
|
|
361
|
+
|
|
362
|
+
```
|
|
363
|
+
USAGE
|
|
364
|
+
$ saltcorn modify-user USER_EMAIL
|
|
365
|
+
|
|
366
|
+
ARGUMENTS
|
|
367
|
+
USER_EMAIL User to modify
|
|
368
|
+
|
|
369
|
+
OPTIONS
|
|
370
|
+
-a, --admin make user be Admin
|
|
371
|
+
-e, --email=email new email
|
|
372
|
+
-i, --imode interactive mode
|
|
373
|
+
-p, --password=password new password
|
|
374
|
+
-r, --role=role new role (can conflict with -a option)
|
|
375
|
+
-t, --tenant=tenant tenant
|
|
376
|
+
|
|
377
|
+
DESCRIPTION
|
|
378
|
+
Command changes the user specified by USER_EMAIL.
|
|
379
|
+
|
|
380
|
+
You can change the user group, password and email.
|
|
381
|
+
|
|
382
|
+
NOTE that -a and -r role (--role=role) can give conflict.
|
|
383
|
+
```
|
|
384
|
+
|
|
385
|
+
_See code: [src/commands/modify-user.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/modify-user.js)_
|
|
307
386
|
|
|
308
387
|
## `saltcorn plugins`
|
|
309
388
|
|
|
310
|
-
List
|
|
389
|
+
List installed plugins.
|
|
311
390
|
|
|
312
391
|
```
|
|
313
392
|
USAGE
|
|
314
393
|
$ saltcorn plugins
|
|
315
394
|
|
|
316
395
|
OPTIONS
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
396
|
+
--core Show core plugins.
|
|
397
|
+
|
|
398
|
+
EXAMPLE
|
|
399
|
+
$ saltcorn plugins
|
|
400
|
+
```
|
|
401
|
+
|
|
402
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.0/src/commands/plugins/index.ts)_
|
|
403
|
+
|
|
404
|
+
## `saltcorn plugins:inspect PLUGIN...`
|
|
405
|
+
|
|
406
|
+
Displays installation properties of a plugin.
|
|
407
|
+
|
|
408
|
+
```
|
|
409
|
+
USAGE
|
|
410
|
+
$ saltcorn plugins:inspect PLUGIN...
|
|
411
|
+
|
|
412
|
+
ARGUMENTS
|
|
413
|
+
PLUGIN [default: .] Plugin to inspect.
|
|
414
|
+
|
|
415
|
+
OPTIONS
|
|
416
|
+
-h, --help Show CLI help.
|
|
417
|
+
-v, --verbose
|
|
418
|
+
|
|
419
|
+
EXAMPLE
|
|
420
|
+
$ saltcorn plugins:inspect myplugin
|
|
421
|
+
```
|
|
422
|
+
|
|
423
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.0/src/commands/plugins/inspect.ts)_
|
|
424
|
+
|
|
425
|
+
## `saltcorn plugins:install PLUGIN...`
|
|
426
|
+
|
|
427
|
+
Installs a plugin into the CLI.
|
|
428
|
+
|
|
429
|
+
```
|
|
430
|
+
USAGE
|
|
431
|
+
$ saltcorn plugins:install PLUGIN...
|
|
432
|
+
|
|
433
|
+
ARGUMENTS
|
|
434
|
+
PLUGIN Plugin to install.
|
|
435
|
+
|
|
436
|
+
OPTIONS
|
|
437
|
+
-f, --force Run yarn install with force flag.
|
|
438
|
+
-h, --help Show CLI help.
|
|
439
|
+
-v, --verbose
|
|
322
440
|
|
|
323
441
|
DESCRIPTION
|
|
324
|
-
|
|
325
|
-
|
|
442
|
+
Can be installed from npm or a git url.
|
|
443
|
+
|
|
444
|
+
Installation of a user-installed plugin will override a core plugin.
|
|
445
|
+
|
|
446
|
+
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
|
|
447
|
+
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
|
|
448
|
+
the CLI without the need to patch and update the whole CLI.
|
|
449
|
+
|
|
450
|
+
ALIASES
|
|
451
|
+
$ saltcorn plugins:add
|
|
326
452
|
|
|
327
453
|
EXAMPLES
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
454
|
+
$ saltcorn plugins:install myplugin
|
|
455
|
+
$ saltcorn plugins:install https://github.com/someuser/someplugin
|
|
456
|
+
$ saltcorn plugins:install someuser/someplugin
|
|
457
|
+
```
|
|
458
|
+
|
|
459
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.0/src/commands/plugins/install.ts)_
|
|
460
|
+
|
|
461
|
+
## `saltcorn plugins:link PLUGIN`
|
|
462
|
+
|
|
463
|
+
Links a plugin into the CLI for development.
|
|
464
|
+
|
|
465
|
+
```
|
|
466
|
+
USAGE
|
|
467
|
+
$ saltcorn plugins:link PLUGIN
|
|
468
|
+
|
|
469
|
+
ARGUMENTS
|
|
470
|
+
PATH [default: .] path to plugin
|
|
471
|
+
|
|
472
|
+
OPTIONS
|
|
473
|
+
-h, --help Show CLI help.
|
|
474
|
+
-v, --verbose
|
|
475
|
+
|
|
476
|
+
DESCRIPTION
|
|
477
|
+
Installation of a linked plugin will override a user-installed or core plugin.
|
|
478
|
+
|
|
479
|
+
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
|
|
480
|
+
command will override the user-installed or core plugin implementation. This is useful for development work.
|
|
481
|
+
|
|
482
|
+
EXAMPLE
|
|
483
|
+
$ saltcorn plugins:link myplugin
|
|
331
484
|
```
|
|
332
485
|
|
|
333
|
-
_See code: [
|
|
486
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.0/src/commands/plugins/link.ts)_
|
|
487
|
+
|
|
488
|
+
## `saltcorn plugins:uninstall PLUGIN...`
|
|
489
|
+
|
|
490
|
+
Removes a plugin from the CLI.
|
|
491
|
+
|
|
492
|
+
```
|
|
493
|
+
USAGE
|
|
494
|
+
$ saltcorn plugins:uninstall PLUGIN...
|
|
495
|
+
|
|
496
|
+
ARGUMENTS
|
|
497
|
+
PLUGIN plugin to uninstall
|
|
498
|
+
|
|
499
|
+
OPTIONS
|
|
500
|
+
-h, --help Show CLI help.
|
|
501
|
+
-v, --verbose
|
|
502
|
+
|
|
503
|
+
ALIASES
|
|
504
|
+
$ saltcorn plugins:unlink
|
|
505
|
+
$ saltcorn plugins:remove
|
|
506
|
+
```
|
|
507
|
+
|
|
508
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.0/src/commands/plugins/uninstall.ts)_
|
|
509
|
+
|
|
510
|
+
## `saltcorn plugins:update`
|
|
511
|
+
|
|
512
|
+
Update installed plugins.
|
|
513
|
+
|
|
514
|
+
```
|
|
515
|
+
USAGE
|
|
516
|
+
$ saltcorn plugins:update
|
|
517
|
+
|
|
518
|
+
OPTIONS
|
|
519
|
+
-h, --help Show CLI help.
|
|
520
|
+
-v, --verbose
|
|
521
|
+
```
|
|
522
|
+
|
|
523
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.0/src/commands/plugins/update.ts)_
|
|
334
524
|
|
|
335
525
|
## `saltcorn release VERSION`
|
|
336
526
|
|
|
@@ -344,7 +534,7 @@ ARGUMENTS
|
|
|
344
534
|
VERSION New version number
|
|
345
535
|
```
|
|
346
536
|
|
|
347
|
-
_See code: [src/commands/release.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.
|
|
537
|
+
_See code: [src/commands/release.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/release.js)_
|
|
348
538
|
|
|
349
539
|
## `saltcorn reset-schema`
|
|
350
540
|
|
|
@@ -355,7 +545,7 @@ USAGE
|
|
|
355
545
|
$ saltcorn reset-schema
|
|
356
546
|
|
|
357
547
|
OPTIONS
|
|
358
|
-
-f, --force force
|
|
548
|
+
-f, --force force command execution
|
|
359
549
|
-t, --tenant=tenant tenant
|
|
360
550
|
|
|
361
551
|
DESCRIPTION
|
|
@@ -363,7 +553,7 @@ DESCRIPTION
|
|
|
363
553
|
This will delete all existing information
|
|
364
554
|
```
|
|
365
555
|
|
|
366
|
-
_See code: [src/commands/reset-schema.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.
|
|
556
|
+
_See code: [src/commands/reset-schema.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/reset-schema.js)_
|
|
367
557
|
|
|
368
558
|
## `saltcorn restore FILE`
|
|
369
559
|
|
|
@@ -380,21 +570,26 @@ OPTIONS
|
|
|
380
570
|
-t, --tenant=tenant tenant
|
|
381
571
|
```
|
|
382
572
|
|
|
383
|
-
_See code: [src/commands/restore.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.
|
|
573
|
+
_See code: [src/commands/restore.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/restore.js)_
|
|
384
574
|
|
|
385
|
-
## `saltcorn rm-tenant
|
|
575
|
+
## `saltcorn rm-tenant`
|
|
386
576
|
|
|
387
|
-
Remove a tenant
|
|
577
|
+
Remove a tenant.
|
|
388
578
|
|
|
389
579
|
```
|
|
390
580
|
USAGE
|
|
391
|
-
$ saltcorn rm-tenant
|
|
581
|
+
$ saltcorn rm-tenant
|
|
392
582
|
|
|
393
|
-
|
|
394
|
-
|
|
583
|
+
OPTIONS
|
|
584
|
+
-f, --force force command execution
|
|
585
|
+
-t, --tenant=tenant (required) tenant
|
|
586
|
+
|
|
587
|
+
DESCRIPTION
|
|
588
|
+
Attention! All tenant data will be lost!
|
|
589
|
+
It recommended to make backup of tenant before perform this command.
|
|
395
590
|
```
|
|
396
591
|
|
|
397
|
-
_See code: [src/commands/rm-tenant.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.
|
|
592
|
+
_See code: [src/commands/rm-tenant.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/rm-tenant.js)_
|
|
398
593
|
|
|
399
594
|
## `saltcorn run-benchmark [BASEURL]`
|
|
400
595
|
|
|
@@ -413,7 +608,7 @@ OPTIONS
|
|
|
413
608
|
-t, --token=token API Token for reporting results
|
|
414
609
|
```
|
|
415
610
|
|
|
416
|
-
_See code: [src/commands/run-benchmark.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.
|
|
611
|
+
_See code: [src/commands/run-benchmark.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/run-benchmark.js)_
|
|
417
612
|
|
|
418
613
|
## `saltcorn run-tests [PACKAGE]`
|
|
419
614
|
|
|
@@ -433,7 +628,7 @@ OPTIONS
|
|
|
433
628
|
--watchAll Watch files for changes and rerun all tests.
|
|
434
629
|
```
|
|
435
630
|
|
|
436
|
-
_See code: [src/commands/run-tests.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.
|
|
631
|
+
_See code: [src/commands/run-tests.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/run-tests.js)_
|
|
437
632
|
|
|
438
633
|
## `saltcorn scheduler`
|
|
439
634
|
|
|
@@ -447,7 +642,7 @@ OPTIONS
|
|
|
447
642
|
-v, --verbose Verbose
|
|
448
643
|
```
|
|
449
644
|
|
|
450
|
-
_See code: [src/commands/scheduler.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.
|
|
645
|
+
_See code: [src/commands/scheduler.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/scheduler.js)_
|
|
451
646
|
|
|
452
647
|
## `saltcorn serve`
|
|
453
648
|
|
|
@@ -467,7 +662,7 @@ OPTIONS
|
|
|
467
662
|
-v, --verbose Verbose
|
|
468
663
|
```
|
|
469
664
|
|
|
470
|
-
_See code: [src/commands/serve.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.
|
|
665
|
+
_See code: [src/commands/serve.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/serve.js)_
|
|
471
666
|
|
|
472
667
|
## `saltcorn set-cfg KEY VALUE`
|
|
473
668
|
|
|
@@ -486,7 +681,7 @@ OPTIONS
|
|
|
486
681
|
-t, --tenant=tenant tenant
|
|
487
682
|
```
|
|
488
683
|
|
|
489
|
-
_See code: [src/commands/set-cfg.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.
|
|
684
|
+
_See code: [src/commands/set-cfg.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/set-cfg.js)_
|
|
490
685
|
|
|
491
686
|
## `saltcorn setup`
|
|
492
687
|
|
|
@@ -501,11 +696,11 @@ OPTIONS
|
|
|
501
696
|
|
|
502
697
|
DESCRIPTION
|
|
503
698
|
...
|
|
504
|
-
This will attempt to install or connect a database, and set up a
|
|
699
|
+
This will attempt to install or connect a database, and set up a
|
|
505
700
|
configuration file
|
|
506
701
|
```
|
|
507
702
|
|
|
508
|
-
_See code: [src/commands/setup.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.
|
|
703
|
+
_See code: [src/commands/setup.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/setup.js)_
|
|
509
704
|
|
|
510
705
|
## `saltcorn setup-benchmark`
|
|
511
706
|
|
|
@@ -519,7 +714,7 @@ OPTIONS
|
|
|
519
714
|
-t, --tenant=tenant tenant
|
|
520
715
|
```
|
|
521
716
|
|
|
522
|
-
_See code: [src/commands/setup-benchmark.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.
|
|
717
|
+
_See code: [src/commands/setup-benchmark.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/setup-benchmark.js)_
|
|
523
718
|
|
|
524
719
|
## `saltcorn test-plugin PATH`
|
|
525
720
|
|
|
@@ -537,7 +732,7 @@ DESCRIPTION
|
|
|
537
732
|
Extra documentation goes here
|
|
538
733
|
```
|
|
539
734
|
|
|
540
|
-
_See code: [src/commands/test-plugin.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.
|
|
735
|
+
_See code: [src/commands/test-plugin.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/test-plugin.js)_
|
|
541
736
|
|
|
542
737
|
## `saltcorn transform-field EXPRESSION FIELD TABLE [TENANT]`
|
|
543
738
|
|
|
@@ -554,5 +749,5 @@ ARGUMENTS
|
|
|
554
749
|
TENANT tenant name
|
|
555
750
|
```
|
|
556
751
|
|
|
557
|
-
_See code: [src/commands/transform-field.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.
|
|
752
|
+
_See code: [src/commands/transform-field.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.10/src/commands/transform-field.js)_
|
|
558
753
|
<!-- commandsstop -->
|
package/oclif.manifest.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":"0.7.2-beta.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":[]},"configuration-check":{"id":"configuration-check","description":"Check configuration","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{"tenant":{"name":"tenant","type":"option","char":"t","description":"tenant"}},"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":[]},"delete-tenants":{"id":"delete-tenants","description":"Delete inactive tenants","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{},"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},"tenant":{"name":"tenant","type":"option","char":"t","description":"tenant"}},"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":"Absolute 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},"dev":{"name":"dev","type":"boolean","char":"d","description":"Run in dev mode and re-start on file changes","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}]}}}
|
|
1
|
+
{"version":"0.7.2-beta.10","commands":{"add-schema":{"id":"add-schema","description":"Add Saltcorn schema to existing database","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{"force":{"name":"force","type":"boolean","char":"f","description":"force command execution","allowNo":false}},"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":[]},"configuration-check":{"id":"configuration-check","description":"Check configuration","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{"tenant":{"name":"tenant","type":"option","char":"t","description":"tenant"}},"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":[]},"delete-tenants":{"id":"delete-tenants","description":"Delete inactive tenants","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"delete-user":{"id":"delete-user","description":"Delete user.\n\nCommand deletes the user specified by USER_EMAIL.\n\n","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{"force":{"name":"force","type":"boolean","char":"f","description":"force command execution","allowNo":false},"tenant":{"name":"tenant","type":"option","char":"t","description":"tenant"}},"args":[{"name":"user_email","description":"User to delete","required":true}]},"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},"tenant":{"name":"tenant","type":"option","char":"t","description":"tenant"}},"args":[]},"get-cfg":{"id":"get-cfg","description":"Get 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}]},"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":"Absolute 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":[]},"modify-user":{"id":"modify-user","description":"Modify (update) user.\n\nCommand changes the user specified by USER_EMAIL.\n\nYou can change the user group, password and email.\n\nNOTE that -a and -r role (--role=role) can give conflict.\n","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{"admin":{"name":"admin","type":"boolean","char":"a","description":"make user be Admin","allowNo":false},"tenant":{"name":"tenant","type":"option","char":"t","description":"tenant"},"email":{"name":"email","type":"option","char":"e","description":"new email"},"role":{"name":"role","type":"option","char":"r","description":"new role (can conflict with -a option)"},"password":{"name":"password","type":"option","char":"p","description":"new password"},"imode":{"name":"imode","type":"boolean","char":"i","description":"interactive mode","allowNo":false}},"args":[{"name":"user_email","description":"User to modify","required":true}]},"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 command execution","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.\nAttention! All tenant data will be lost!\nIt recommended to make backup of tenant before perform this command.\n","pluginName":"@saltcorn/cli","pluginType":"core","aliases":[],"flags":{"force":{"name":"force","type":"boolean","char":"f","description":"force command execution","allowNo":false},"tenant":{"name":"tenant","type":"option","char":"t","description":"tenant","required":true}},"args":[]},"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},"dev":{"name":"dev","type":"boolean","char":"d","description":"Run in dev mode and re-start on file changes","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}]}}}
|