@saltcorn/cli 0.7.3-beta.2 → 0.7.3-beta.3
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 +57 -36
- package/npm-shrinkwrap.json +696 -352
- package/oclif.manifest.json +1 -1
- package/package.json +4 -4
- package/src/commands/get-cfg.js +1 -1
- package/src/commands/inspect.js +75 -0
- package/src/commands/set-cfg.js +25 -5
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.3-beta.
|
|
23
|
+
@saltcorn/cli/0.7.3-beta.3 darwin-arm64 node-v16.15.1
|
|
24
24
|
$ saltcorn --help [COMMAND]
|
|
25
25
|
USAGE
|
|
26
26
|
$ saltcorn COMMAND
|
|
@@ -42,6 +42,7 @@ USAGE
|
|
|
42
42
|
* [`saltcorn get-cfg KEY`](#saltcorn-get-cfg-key)
|
|
43
43
|
* [`saltcorn help [COMMAND]`](#saltcorn-help-command)
|
|
44
44
|
* [`saltcorn info`](#saltcorn-info)
|
|
45
|
+
* [`saltcorn inspect TYPE [NAME]`](#saltcorn-inspect-type-name)
|
|
45
46
|
* [`saltcorn install-pack`](#saltcorn-install-pack)
|
|
46
47
|
* [`saltcorn install-plugin`](#saltcorn-install-plugin)
|
|
47
48
|
* [`saltcorn list-tenants`](#saltcorn-list-tenants)
|
|
@@ -63,7 +64,7 @@ USAGE
|
|
|
63
64
|
* [`saltcorn run-tests [PACKAGE]`](#saltcorn-run-tests-package)
|
|
64
65
|
* [`saltcorn scheduler`](#saltcorn-scheduler)
|
|
65
66
|
* [`saltcorn serve`](#saltcorn-serve)
|
|
66
|
-
* [`saltcorn set-cfg KEY VALUE`](#saltcorn-set-cfg-key-value)
|
|
67
|
+
* [`saltcorn set-cfg KEY [VALUE]`](#saltcorn-set-cfg-key-value)
|
|
67
68
|
* [`saltcorn setup`](#saltcorn-setup)
|
|
68
69
|
* [`saltcorn setup-benchmark`](#saltcorn-setup-benchmark)
|
|
69
70
|
* [`saltcorn test-plugin PATH`](#saltcorn-test-plugin-path)
|
|
@@ -81,7 +82,7 @@ OPTIONS
|
|
|
81
82
|
-f, --force force command execution
|
|
82
83
|
```
|
|
83
84
|
|
|
84
|
-
_See code: [src/commands/add-schema.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.
|
|
85
|
+
_See code: [src/commands/add-schema.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.3/src/commands/add-schema.js)_
|
|
85
86
|
|
|
86
87
|
## `saltcorn backup`
|
|
87
88
|
|
|
@@ -97,7 +98,7 @@ OPTIONS
|
|
|
97
98
|
-z, --zip zip format
|
|
98
99
|
```
|
|
99
100
|
|
|
100
|
-
_See code: [src/commands/backup.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.
|
|
101
|
+
_See code: [src/commands/backup.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.3/src/commands/backup.js)_
|
|
101
102
|
|
|
102
103
|
## `saltcorn configuration-check`
|
|
103
104
|
|
|
@@ -111,7 +112,7 @@ OPTIONS
|
|
|
111
112
|
-t, --tenant=tenant tenant
|
|
112
113
|
```
|
|
113
114
|
|
|
114
|
-
_See code: [src/commands/configuration-check.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.
|
|
115
|
+
_See code: [src/commands/configuration-check.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.3/src/commands/configuration-check.js)_
|
|
115
116
|
|
|
116
117
|
## `saltcorn create-tenant TENANT`
|
|
117
118
|
|
|
@@ -129,7 +130,7 @@ OPTIONS
|
|
|
129
130
|
-e, --email=email Email of owner of tenant
|
|
130
131
|
```
|
|
131
132
|
|
|
132
|
-
_See code: [src/commands/create-tenant.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.
|
|
133
|
+
_See code: [src/commands/create-tenant.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.3/src/commands/create-tenant.js)_
|
|
133
134
|
|
|
134
135
|
## `saltcorn create-user`
|
|
135
136
|
|
|
@@ -147,7 +148,7 @@ OPTIONS
|
|
|
147
148
|
-t, --tenant=tenant tenant
|
|
148
149
|
```
|
|
149
150
|
|
|
150
|
-
_See code: [src/commands/create-user.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.
|
|
151
|
+
_See code: [src/commands/create-user.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.3/src/commands/create-user.js)_
|
|
151
152
|
|
|
152
153
|
## `saltcorn delete-tenants`
|
|
153
154
|
|
|
@@ -158,7 +159,7 @@ USAGE
|
|
|
158
159
|
$ saltcorn delete-tenants
|
|
159
160
|
```
|
|
160
161
|
|
|
161
|
-
_See code: [src/commands/delete-tenants.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.
|
|
162
|
+
_See code: [src/commands/delete-tenants.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.3/src/commands/delete-tenants.js)_
|
|
162
163
|
|
|
163
164
|
## `saltcorn delete-user USER_EMAIL`
|
|
164
165
|
|
|
@@ -179,7 +180,7 @@ DESCRIPTION
|
|
|
179
180
|
Command deletes the user specified by USER_EMAIL.
|
|
180
181
|
```
|
|
181
182
|
|
|
182
|
-
_See code: [src/commands/delete-user.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.
|
|
183
|
+
_See code: [src/commands/delete-user.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.3/src/commands/delete-user.js)_
|
|
183
184
|
|
|
184
185
|
## `saltcorn fixtures`
|
|
185
186
|
|
|
@@ -198,11 +199,11 @@ DESCRIPTION
|
|
|
198
199
|
This manual step it is never required for users and rarely required for developers
|
|
199
200
|
```
|
|
200
201
|
|
|
201
|
-
_See code: [src/commands/fixtures.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.
|
|
202
|
+
_See code: [src/commands/fixtures.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.3/src/commands/fixtures.js)_
|
|
202
203
|
|
|
203
204
|
## `saltcorn get-cfg KEY`
|
|
204
205
|
|
|
205
|
-
Get a configuration value
|
|
206
|
+
Get a configuration value. The value is printed to stdout as a JSON value
|
|
206
207
|
|
|
207
208
|
```
|
|
208
209
|
USAGE
|
|
@@ -216,7 +217,7 @@ OPTIONS
|
|
|
216
217
|
-t, --tenant=tenant tenant
|
|
217
218
|
```
|
|
218
219
|
|
|
219
|
-
_See code: [src/commands/get-cfg.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.
|
|
220
|
+
_See code: [src/commands/get-cfg.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.3/src/commands/get-cfg.js)_
|
|
220
221
|
|
|
221
222
|
## `saltcorn help [COMMAND]`
|
|
222
223
|
|
|
@@ -254,7 +255,25 @@ ALIASES
|
|
|
254
255
|
$ saltcorn paths
|
|
255
256
|
```
|
|
256
257
|
|
|
257
|
-
_See code: [src/commands/info.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.
|
|
258
|
+
_See code: [src/commands/info.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.3/src/commands/info.js)_
|
|
259
|
+
|
|
260
|
+
## `saltcorn inspect TYPE [NAME]`
|
|
261
|
+
|
|
262
|
+
Inspect an entity's JSON representation, or list entities
|
|
263
|
+
|
|
264
|
+
```
|
|
265
|
+
USAGE
|
|
266
|
+
$ saltcorn inspect TYPE [NAME]
|
|
267
|
+
|
|
268
|
+
ARGUMENTS
|
|
269
|
+
TYPE (view|page|trigger|table) Entity type
|
|
270
|
+
NAME Entity name. If not supplied, list all names
|
|
271
|
+
|
|
272
|
+
OPTIONS
|
|
273
|
+
-t, --tenant=tenant tenant
|
|
274
|
+
```
|
|
275
|
+
|
|
276
|
+
_See code: [src/commands/inspect.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.3/src/commands/inspect.js)_
|
|
258
277
|
|
|
259
278
|
## `saltcorn install-pack`
|
|
260
279
|
|
|
@@ -270,7 +289,7 @@ OPTIONS
|
|
|
270
289
|
-t, --tenant=tenant tenant
|
|
271
290
|
```
|
|
272
291
|
|
|
273
|
-
_See code: [src/commands/install-pack.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.
|
|
292
|
+
_See code: [src/commands/install-pack.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.3/src/commands/install-pack.js)_
|
|
274
293
|
|
|
275
294
|
## `saltcorn install-plugin`
|
|
276
295
|
|
|
@@ -286,7 +305,7 @@ OPTIONS
|
|
|
286
305
|
-t, --tenant=tenant tenant
|
|
287
306
|
```
|
|
288
307
|
|
|
289
|
-
_See code: [src/commands/install-plugin.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.
|
|
308
|
+
_See code: [src/commands/install-plugin.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.3/src/commands/install-plugin.js)_
|
|
290
309
|
|
|
291
310
|
## `saltcorn list-tenants`
|
|
292
311
|
|
|
@@ -297,7 +316,7 @@ USAGE
|
|
|
297
316
|
$ saltcorn list-tenants
|
|
298
317
|
```
|
|
299
318
|
|
|
300
|
-
_See code: [src/commands/list-tenants.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.
|
|
319
|
+
_See code: [src/commands/list-tenants.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.3/src/commands/list-tenants.js)_
|
|
301
320
|
|
|
302
321
|
## `saltcorn localize-plugin PLUGIN PATH`
|
|
303
322
|
|
|
@@ -315,7 +334,7 @@ OPTIONS
|
|
|
315
334
|
-t, --tenant=tenant tenant
|
|
316
335
|
```
|
|
317
336
|
|
|
318
|
-
_See code: [src/commands/localize-plugin.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.
|
|
337
|
+
_See code: [src/commands/localize-plugin.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.3/src/commands/localize-plugin.js)_
|
|
319
338
|
|
|
320
339
|
## `saltcorn make-migration`
|
|
321
340
|
|
|
@@ -331,7 +350,7 @@ DESCRIPTION
|
|
|
331
350
|
unless you are a developer.
|
|
332
351
|
```
|
|
333
352
|
|
|
334
|
-
_See code: [src/commands/make-migration.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.
|
|
353
|
+
_See code: [src/commands/make-migration.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.3/src/commands/make-migration.js)_
|
|
335
354
|
|
|
336
355
|
## `saltcorn saltcorn migrate`
|
|
337
356
|
|
|
@@ -353,7 +372,7 @@ DESCRIPTION
|
|
|
353
372
|
servers and need to control when the migrations are run.
|
|
354
373
|
```
|
|
355
374
|
|
|
356
|
-
_See code: [src/commands/migrate.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.
|
|
375
|
+
_See code: [src/commands/migrate.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.3/src/commands/migrate.js)_
|
|
357
376
|
|
|
358
377
|
## `saltcorn modify-user USER_EMAIL`
|
|
359
378
|
|
|
@@ -382,7 +401,7 @@ DESCRIPTION
|
|
|
382
401
|
NOTE that -a and -r role (--role=role) can give conflict.
|
|
383
402
|
```
|
|
384
403
|
|
|
385
|
-
_See code: [src/commands/modify-user.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.
|
|
404
|
+
_See code: [src/commands/modify-user.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.3/src/commands/modify-user.js)_
|
|
386
405
|
|
|
387
406
|
## `saltcorn plugins`
|
|
388
407
|
|
|
@@ -534,7 +553,7 @@ ARGUMENTS
|
|
|
534
553
|
VERSION New version number
|
|
535
554
|
```
|
|
536
555
|
|
|
537
|
-
_See code: [src/commands/release.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.
|
|
556
|
+
_See code: [src/commands/release.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.3/src/commands/release.js)_
|
|
538
557
|
|
|
539
558
|
## `saltcorn reset-schema`
|
|
540
559
|
|
|
@@ -553,7 +572,7 @@ DESCRIPTION
|
|
|
553
572
|
This will delete all existing information
|
|
554
573
|
```
|
|
555
574
|
|
|
556
|
-
_See code: [src/commands/reset-schema.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.
|
|
575
|
+
_See code: [src/commands/reset-schema.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.3/src/commands/reset-schema.js)_
|
|
557
576
|
|
|
558
577
|
## `saltcorn restore FILE`
|
|
559
578
|
|
|
@@ -570,7 +589,7 @@ OPTIONS
|
|
|
570
589
|
-t, --tenant=tenant tenant
|
|
571
590
|
```
|
|
572
591
|
|
|
573
|
-
_See code: [src/commands/restore.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.
|
|
592
|
+
_See code: [src/commands/restore.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.3/src/commands/restore.js)_
|
|
574
593
|
|
|
575
594
|
## `saltcorn rm-tenant`
|
|
576
595
|
|
|
@@ -589,7 +608,7 @@ DESCRIPTION
|
|
|
589
608
|
It recommended to make backup of tenant before perform this command.
|
|
590
609
|
```
|
|
591
610
|
|
|
592
|
-
_See code: [src/commands/rm-tenant.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.
|
|
611
|
+
_See code: [src/commands/rm-tenant.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.3/src/commands/rm-tenant.js)_
|
|
593
612
|
|
|
594
613
|
## `saltcorn run-benchmark [BASEURL]`
|
|
595
614
|
|
|
@@ -608,7 +627,7 @@ OPTIONS
|
|
|
608
627
|
-t, --token=token API Token for reporting results
|
|
609
628
|
```
|
|
610
629
|
|
|
611
|
-
_See code: [src/commands/run-benchmark.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.
|
|
630
|
+
_See code: [src/commands/run-benchmark.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.3/src/commands/run-benchmark.js)_
|
|
612
631
|
|
|
613
632
|
## `saltcorn run-tests [PACKAGE]`
|
|
614
633
|
|
|
@@ -628,7 +647,7 @@ OPTIONS
|
|
|
628
647
|
--watchAll Watch files for changes and rerun all tests.
|
|
629
648
|
```
|
|
630
649
|
|
|
631
|
-
_See code: [src/commands/run-tests.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.
|
|
650
|
+
_See code: [src/commands/run-tests.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.3/src/commands/run-tests.js)_
|
|
632
651
|
|
|
633
652
|
## `saltcorn scheduler`
|
|
634
653
|
|
|
@@ -642,7 +661,7 @@ OPTIONS
|
|
|
642
661
|
-v, --verbose Verbose
|
|
643
662
|
```
|
|
644
663
|
|
|
645
|
-
_See code: [src/commands/scheduler.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.
|
|
664
|
+
_See code: [src/commands/scheduler.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.3/src/commands/scheduler.js)_
|
|
646
665
|
|
|
647
666
|
## `saltcorn serve`
|
|
648
667
|
|
|
@@ -662,26 +681,28 @@ OPTIONS
|
|
|
662
681
|
-v, --verbose Verbose
|
|
663
682
|
```
|
|
664
683
|
|
|
665
|
-
_See code: [src/commands/serve.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.
|
|
684
|
+
_See code: [src/commands/serve.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.3/src/commands/serve.js)_
|
|
666
685
|
|
|
667
|
-
## `saltcorn set-cfg KEY VALUE`
|
|
686
|
+
## `saltcorn set-cfg KEY [VALUE]`
|
|
668
687
|
|
|
669
|
-
Set a configuration value
|
|
688
|
+
Set a configuration value. The supplied value (argument, or file stdin) will be parsed as JSON. If this fails, it is stored as a string.
|
|
670
689
|
|
|
671
690
|
```
|
|
672
691
|
USAGE
|
|
673
|
-
$ saltcorn set-cfg KEY VALUE
|
|
692
|
+
$ saltcorn set-cfg KEY [VALUE]
|
|
674
693
|
|
|
675
694
|
ARGUMENTS
|
|
676
695
|
KEY Configuration key
|
|
677
696
|
VALUE Configuration value (JSON or string)
|
|
678
697
|
|
|
679
698
|
OPTIONS
|
|
699
|
+
-f, --file=file file
|
|
700
|
+
-i, --stdin read value from stdin
|
|
680
701
|
-p, --plugin=plugin plugin
|
|
681
702
|
-t, --tenant=tenant tenant
|
|
682
703
|
```
|
|
683
704
|
|
|
684
|
-
_See code: [src/commands/set-cfg.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.
|
|
705
|
+
_See code: [src/commands/set-cfg.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.3/src/commands/set-cfg.js)_
|
|
685
706
|
|
|
686
707
|
## `saltcorn setup`
|
|
687
708
|
|
|
@@ -700,7 +721,7 @@ DESCRIPTION
|
|
|
700
721
|
configuration file
|
|
701
722
|
```
|
|
702
723
|
|
|
703
|
-
_See code: [src/commands/setup.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.
|
|
724
|
+
_See code: [src/commands/setup.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.3/src/commands/setup.js)_
|
|
704
725
|
|
|
705
726
|
## `saltcorn setup-benchmark`
|
|
706
727
|
|
|
@@ -714,7 +735,7 @@ OPTIONS
|
|
|
714
735
|
-t, --tenant=tenant tenant
|
|
715
736
|
```
|
|
716
737
|
|
|
717
|
-
_See code: [src/commands/setup-benchmark.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.
|
|
738
|
+
_See code: [src/commands/setup-benchmark.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.3/src/commands/setup-benchmark.js)_
|
|
718
739
|
|
|
719
740
|
## `saltcorn test-plugin PATH`
|
|
720
741
|
|
|
@@ -732,7 +753,7 @@ DESCRIPTION
|
|
|
732
753
|
Extra documentation goes here
|
|
733
754
|
```
|
|
734
755
|
|
|
735
|
-
_See code: [src/commands/test-plugin.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.
|
|
756
|
+
_See code: [src/commands/test-plugin.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.3/src/commands/test-plugin.js)_
|
|
736
757
|
|
|
737
758
|
## `saltcorn transform-field EXPRESSION FIELD TABLE [TENANT]`
|
|
738
759
|
|
|
@@ -749,5 +770,5 @@ ARGUMENTS
|
|
|
749
770
|
TENANT tenant name
|
|
750
771
|
```
|
|
751
772
|
|
|
752
|
-
_See code: [src/commands/transform-field.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.
|
|
773
|
+
_See code: [src/commands/transform-field.js](https://github.com/saltcorn/saltcorn/blob/v0.7.3-beta.3/src/commands/transform-field.js)_
|
|
753
774
|
<!-- commandsstop -->
|