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

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 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.1-beta.3 darwin-x64 node-v14.16.1
23
+ @saltcorn/cli/0.7.2-beta.2 linux-x64 node-v14.19.2
24
24
  $ saltcorn --help [COMMAND]
25
25
  USAGE
26
26
  $ saltcorn COMMAND
@@ -33,11 +33,13 @@ USAGE
33
33
  <!-- commands -->
34
34
  * [`saltcorn add-schema`](#saltcorn-add-schema)
35
35
  * [`saltcorn backup`](#saltcorn-backup)
36
+ * [`saltcorn build-app`](#saltcorn-build-app)
36
37
  * [`saltcorn configuration-check`](#saltcorn-configuration-check)
37
38
  * [`saltcorn create-tenant TENANT`](#saltcorn-create-tenant-tenant)
38
39
  * [`saltcorn create-user`](#saltcorn-create-user)
39
40
  * [`saltcorn delete-tenants`](#saltcorn-delete-tenants)
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)
@@ -47,6 +49,11 @@ USAGE
47
49
  * [`saltcorn make-migration`](#saltcorn-make-migration)
48
50
  * [`saltcorn saltcorn migrate`](#saltcorn-saltcorn-migrate)
49
51
  * [`saltcorn plugins`](#saltcorn-plugins)
52
+ * [`saltcorn plugins:inspect PLUGIN...`](#saltcorn-pluginsinspect-plugin)
53
+ * [`saltcorn plugins:install PLUGIN...`](#saltcorn-pluginsinstall-plugin)
54
+ * [`saltcorn plugins:link PLUGIN`](#saltcorn-pluginslink-plugin)
55
+ * [`saltcorn plugins:uninstall PLUGIN...`](#saltcorn-pluginsuninstall-plugin)
56
+ * [`saltcorn plugins:update`](#saltcorn-pluginsupdate)
50
57
  * [`saltcorn release VERSION`](#saltcorn-release-version)
51
58
  * [`saltcorn reset-schema`](#saltcorn-reset-schema)
52
59
  * [`saltcorn restore FILE`](#saltcorn-restore-file)
@@ -70,7 +77,7 @@ USAGE
70
77
  $ saltcorn add-schema
71
78
  ```
72
79
 
73
- _See code: [src/commands/add-schema.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/add-schema.js)_
80
+ _See code: [src/commands/add-schema.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.2/src/commands/add-schema.js)_
74
81
 
75
82
  ## `saltcorn backup`
76
83
 
@@ -86,7 +93,23 @@ OPTIONS
86
93
  -z, --zip zip format
87
94
  ```
88
95
 
89
- _See code: [src/commands/backup.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/backup.js)_
96
+ _See code: [src/commands/backup.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.2/src/commands/backup.js)_
97
+
98
+ ## `saltcorn build-app`
99
+
100
+ build mobile app from tenant
101
+
102
+ ```
103
+ USAGE
104
+ $ saltcorn build-app
105
+
106
+ OPTIONS
107
+ -l, --localUserTables=localUserTables user defined tables that should be replicated into the app
108
+ -p, --platforms=platforms Platforms to build for space separated list
109
+ -v, --entryPoint=entryPoint Entry Point
110
+ ```
111
+
112
+ _See code: [@saltcorn/mobile-builder](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.0/dist/commands/build-app.js)_
90
113
 
91
114
  ## `saltcorn configuration-check`
92
115
 
@@ -100,7 +123,7 @@ OPTIONS
100
123
  -t, --tenant=tenant tenant
101
124
  ```
102
125
 
103
- _See code: [src/commands/configuration-check.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/configuration-check.js)_
126
+ _See code: [src/commands/configuration-check.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.2/src/commands/configuration-check.js)_
104
127
 
105
128
  ## `saltcorn create-tenant TENANT`
106
129
 
@@ -118,7 +141,7 @@ OPTIONS
118
141
  -e, --email=email Email of owner of tenant
119
142
  ```
120
143
 
121
- _See code: [src/commands/create-tenant.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/create-tenant.js)_
144
+ _See code: [src/commands/create-tenant.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.2/src/commands/create-tenant.js)_
122
145
 
123
146
  ## `saltcorn create-user`
124
147
 
@@ -136,7 +159,7 @@ OPTIONS
136
159
  -t, --tenant=tenant tenant
137
160
  ```
138
161
 
139
- _See code: [src/commands/create-user.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/create-user.js)_
162
+ _See code: [src/commands/create-user.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.2/src/commands/create-user.js)_
140
163
 
141
164
  ## `saltcorn delete-tenants`
142
165
 
@@ -147,7 +170,7 @@ USAGE
147
170
  $ saltcorn delete-tenants
148
171
  ```
149
172
 
150
- _See code: [src/commands/delete-tenants.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/delete-tenants.js)_
173
+ _See code: [src/commands/delete-tenants.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.2/src/commands/delete-tenants.js)_
151
174
 
152
175
  ## `saltcorn fixtures`
153
176
 
@@ -166,7 +189,25 @@ DESCRIPTION
166
189
  This manual step it is never required for users and rarely required for developers
167
190
  ```
168
191
 
169
- _See code: [src/commands/fixtures.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/fixtures.js)_
192
+ _See code: [src/commands/fixtures.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.2/src/commands/fixtures.js)_
193
+
194
+ ## `saltcorn get-cfg KEY`
195
+
196
+ Get a configuration value
197
+
198
+ ```
199
+ USAGE
200
+ $ saltcorn get-cfg KEY
201
+
202
+ ARGUMENTS
203
+ KEY Configuration key
204
+
205
+ OPTIONS
206
+ -p, --plugin=plugin plugin
207
+ -t, --tenant=tenant tenant
208
+ ```
209
+
210
+ _See code: [src/commands/get-cfg.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.2/src/commands/get-cfg.js)_
170
211
 
171
212
  ## `saltcorn help [COMMAND]`
172
213
 
@@ -183,7 +224,7 @@ OPTIONS
183
224
  --all see all commands in CLI
184
225
  ```
185
226
 
186
- _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.3.1/src/commands/help.ts)_
227
+ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.18/src/commands/help.ts)_
187
228
 
188
229
  ## `saltcorn info`
189
230
 
@@ -204,7 +245,7 @@ ALIASES
204
245
  $ saltcorn paths
205
246
  ```
206
247
 
207
- _See code: [src/commands/info.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/info.js)_
248
+ _See code: [src/commands/info.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.2/src/commands/info.js)_
208
249
 
209
250
  ## `saltcorn install-pack`
210
251
 
@@ -220,7 +261,7 @@ OPTIONS
220
261
  -t, --tenant=tenant tenant
221
262
  ```
222
263
 
223
- _See code: [src/commands/install-pack.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/install-pack.js)_
264
+ _See code: [src/commands/install-pack.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.2/src/commands/install-pack.js)_
224
265
 
225
266
  ## `saltcorn install-plugin`
226
267
 
@@ -236,7 +277,7 @@ OPTIONS
236
277
  -t, --tenant=tenant tenant
237
278
  ```
238
279
 
239
- _See code: [src/commands/install-plugin.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/install-plugin.js)_
280
+ _See code: [src/commands/install-plugin.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.2/src/commands/install-plugin.js)_
240
281
 
241
282
  ## `saltcorn list-tenants`
242
283
 
@@ -247,7 +288,7 @@ USAGE
247
288
  $ saltcorn list-tenants
248
289
  ```
249
290
 
250
- _See code: [src/commands/list-tenants.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/list-tenants.js)_
291
+ _See code: [src/commands/list-tenants.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.2/src/commands/list-tenants.js)_
251
292
 
252
293
  ## `saltcorn localize-plugin PLUGIN PATH`
253
294
 
@@ -265,7 +306,7 @@ OPTIONS
265
306
  -t, --tenant=tenant tenant
266
307
  ```
267
308
 
268
- _See code: [src/commands/localize-plugin.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/localize-plugin.js)_
309
+ _See code: [src/commands/localize-plugin.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.2/src/commands/localize-plugin.js)_
269
310
 
270
311
  ## `saltcorn make-migration`
271
312
 
@@ -281,7 +322,7 @@ DESCRIPTION
281
322
  unless you are a developer.
282
323
  ```
283
324
 
284
- _See code: [src/commands/make-migration.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/make-migration.js)_
325
+ _See code: [src/commands/make-migration.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.2/src/commands/make-migration.js)_
285
326
 
286
327
  ## `saltcorn saltcorn migrate`
287
328
 
@@ -303,34 +344,145 @@ DESCRIPTION
303
344
  servers and need to control when the migrations are run.
304
345
  ```
305
346
 
306
- _See code: [src/commands/migrate.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/migrate.js)_
347
+ _See code: [src/commands/migrate.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.2/src/commands/migrate.js)_
307
348
 
308
349
  ## `saltcorn plugins`
309
350
 
310
- List and upgrade plugins for tenants
351
+ List installed plugins.
311
352
 
312
353
  ```
313
354
  USAGE
314
355
  $ saltcorn plugins
315
356
 
316
357
  OPTIONS
317
- -d, --dryRun Upgrade dry-run
318
- -f, --force Force update
319
- -n, --name=name Plugin name
320
- -u, --upgrade Upgrade
321
- -v, --verbose Verbose output
358
+ --core Show core plugins.
359
+
360
+ EXAMPLE
361
+ $ saltcorn plugins
362
+ ```
363
+
364
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.0/src/commands/plugins/index.ts)_
365
+
366
+ ## `saltcorn plugins:inspect PLUGIN...`
367
+
368
+ Displays installation properties of a plugin.
369
+
370
+ ```
371
+ USAGE
372
+ $ saltcorn plugins:inspect PLUGIN...
373
+
374
+ ARGUMENTS
375
+ PLUGIN [default: .] Plugin to inspect.
376
+
377
+ OPTIONS
378
+ -h, --help Show CLI help.
379
+ -v, --verbose
380
+
381
+ EXAMPLE
382
+ $ saltcorn plugins:inspect myplugin
383
+ ```
384
+
385
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.0/src/commands/plugins/inspect.ts)_
386
+
387
+ ## `saltcorn plugins:install PLUGIN...`
388
+
389
+ Installs a plugin into the CLI.
390
+
391
+ ```
392
+ USAGE
393
+ $ saltcorn plugins:install PLUGIN...
394
+
395
+ ARGUMENTS
396
+ PLUGIN Plugin to install.
397
+
398
+ OPTIONS
399
+ -f, --force Run yarn install with force flag.
400
+ -h, --help Show CLI help.
401
+ -v, --verbose
322
402
 
323
403
  DESCRIPTION
324
- ...
325
- Extra documentation goes here
404
+ Can be installed from npm or a git url.
405
+
406
+ Installation of a user-installed plugin will override a core plugin.
407
+
408
+ e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
409
+ will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
410
+ the CLI without the need to patch and update the whole CLI.
411
+
412
+ ALIASES
413
+ $ saltcorn plugins:add
326
414
 
327
415
  EXAMPLES
328
- plugins -v - verbose output of commands
329
- plugins -u -d - dry-run for plugin update
330
- plugins -u -f - force plugin update
416
+ $ saltcorn plugins:install myplugin
417
+ $ saltcorn plugins:install https://github.com/someuser/someplugin
418
+ $ saltcorn plugins:install someuser/someplugin
419
+ ```
420
+
421
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.0/src/commands/plugins/install.ts)_
422
+
423
+ ## `saltcorn plugins:link PLUGIN`
424
+
425
+ Links a plugin into the CLI for development.
426
+
427
+ ```
428
+ USAGE
429
+ $ saltcorn plugins:link PLUGIN
430
+
431
+ ARGUMENTS
432
+ PATH [default: .] path to plugin
433
+
434
+ OPTIONS
435
+ -h, --help Show CLI help.
436
+ -v, --verbose
437
+
438
+ DESCRIPTION
439
+ Installation of a linked plugin will override a user-installed or core plugin.
440
+
441
+ e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
442
+ command will override the user-installed or core plugin implementation. This is useful for development work.
443
+
444
+ EXAMPLE
445
+ $ saltcorn plugins:link myplugin
446
+ ```
447
+
448
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.0/src/commands/plugins/link.ts)_
449
+
450
+ ## `saltcorn plugins:uninstall PLUGIN...`
451
+
452
+ Removes a plugin from the CLI.
453
+
454
+ ```
455
+ USAGE
456
+ $ saltcorn plugins:uninstall PLUGIN...
457
+
458
+ ARGUMENTS
459
+ PLUGIN plugin to uninstall
460
+
461
+ OPTIONS
462
+ -h, --help Show CLI help.
463
+ -v, --verbose
464
+
465
+ ALIASES
466
+ $ saltcorn plugins:unlink
467
+ $ saltcorn plugins:remove
468
+ ```
469
+
470
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.0/src/commands/plugins/uninstall.ts)_
471
+
472
+ ## `saltcorn plugins:update`
473
+
474
+ Update installed plugins.
475
+
476
+ ```
477
+ USAGE
478
+ $ saltcorn plugins:update
479
+
480
+ OPTIONS
481
+ -h, --help Show CLI help.
482
+ -v, --verbose
331
483
  ```
332
484
 
333
- _See code: [src/commands/plugins.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/plugins.js)_
485
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.0/src/commands/plugins/update.ts)_
334
486
 
335
487
  ## `saltcorn release VERSION`
336
488
 
@@ -344,7 +496,7 @@ ARGUMENTS
344
496
  VERSION New version number
345
497
  ```
346
498
 
347
- _See code: [src/commands/release.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/release.js)_
499
+ _See code: [src/commands/release.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.2/src/commands/release.js)_
348
500
 
349
501
  ## `saltcorn reset-schema`
350
502
 
@@ -363,7 +515,7 @@ DESCRIPTION
363
515
  This will delete all existing information
364
516
  ```
365
517
 
366
- _See code: [src/commands/reset-schema.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/reset-schema.js)_
518
+ _See code: [src/commands/reset-schema.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.2/src/commands/reset-schema.js)_
367
519
 
368
520
  ## `saltcorn restore FILE`
369
521
 
@@ -380,7 +532,7 @@ OPTIONS
380
532
  -t, --tenant=tenant tenant
381
533
  ```
382
534
 
383
- _See code: [src/commands/restore.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/restore.js)_
535
+ _See code: [src/commands/restore.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.2/src/commands/restore.js)_
384
536
 
385
537
  ## `saltcorn rm-tenant TENANT`
386
538
 
@@ -394,7 +546,7 @@ ARGUMENTS
394
546
  TENANT Tenant to remove
395
547
  ```
396
548
 
397
- _See code: [src/commands/rm-tenant.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/rm-tenant.js)_
549
+ _See code: [src/commands/rm-tenant.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.2/src/commands/rm-tenant.js)_
398
550
 
399
551
  ## `saltcorn run-benchmark [BASEURL]`
400
552
 
@@ -413,7 +565,7 @@ OPTIONS
413
565
  -t, --token=token API Token for reporting results
414
566
  ```
415
567
 
416
- _See code: [src/commands/run-benchmark.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/run-benchmark.js)_
568
+ _See code: [src/commands/run-benchmark.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.2/src/commands/run-benchmark.js)_
417
569
 
418
570
  ## `saltcorn run-tests [PACKAGE]`
419
571
 
@@ -433,7 +585,7 @@ OPTIONS
433
585
  --watchAll Watch files for changes and rerun all tests.
434
586
  ```
435
587
 
436
- _See code: [src/commands/run-tests.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/run-tests.js)_
588
+ _See code: [src/commands/run-tests.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.2/src/commands/run-tests.js)_
437
589
 
438
590
  ## `saltcorn scheduler`
439
591
 
@@ -447,7 +599,7 @@ OPTIONS
447
599
  -v, --verbose Verbose
448
600
  ```
449
601
 
450
- _See code: [src/commands/scheduler.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/scheduler.js)_
602
+ _See code: [src/commands/scheduler.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.2/src/commands/scheduler.js)_
451
603
 
452
604
  ## `saltcorn serve`
453
605
 
@@ -467,7 +619,7 @@ OPTIONS
467
619
  -v, --verbose Verbose
468
620
  ```
469
621
 
470
- _See code: [src/commands/serve.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/serve.js)_
622
+ _See code: [src/commands/serve.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.2/src/commands/serve.js)_
471
623
 
472
624
  ## `saltcorn set-cfg KEY VALUE`
473
625
 
@@ -486,7 +638,7 @@ OPTIONS
486
638
  -t, --tenant=tenant tenant
487
639
  ```
488
640
 
489
- _See code: [src/commands/set-cfg.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/set-cfg.js)_
641
+ _See code: [src/commands/set-cfg.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.2/src/commands/set-cfg.js)_
490
642
 
491
643
  ## `saltcorn setup`
492
644
 
@@ -505,7 +657,7 @@ DESCRIPTION
505
657
  configuration file
506
658
  ```
507
659
 
508
- _See code: [src/commands/setup.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/setup.js)_
660
+ _See code: [src/commands/setup.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.2/src/commands/setup.js)_
509
661
 
510
662
  ## `saltcorn setup-benchmark`
511
663
 
@@ -519,7 +671,7 @@ OPTIONS
519
671
  -t, --tenant=tenant tenant
520
672
  ```
521
673
 
522
- _See code: [src/commands/setup-benchmark.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/setup-benchmark.js)_
674
+ _See code: [src/commands/setup-benchmark.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.2/src/commands/setup-benchmark.js)_
523
675
 
524
676
  ## `saltcorn test-plugin PATH`
525
677
 
@@ -537,7 +689,7 @@ DESCRIPTION
537
689
  Extra documentation goes here
538
690
  ```
539
691
 
540
- _See code: [src/commands/test-plugin.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/test-plugin.js)_
692
+ _See code: [src/commands/test-plugin.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.2/src/commands/test-plugin.js)_
541
693
 
542
694
  ## `saltcorn transform-field EXPRESSION FIELD TABLE [TENANT]`
543
695
 
@@ -554,5 +706,5 @@ ARGUMENTS
554
706
  TENANT tenant name
555
707
  ```
556
708
 
557
- _See code: [src/commands/transform-field.js](https://github.com/saltcorn/saltcorn/blob/v0.7.1-beta.3/src/commands/transform-field.js)_
709
+ _See code: [src/commands/transform-field.js](https://github.com/saltcorn/saltcorn/blob/v0.7.2-beta.2/src/commands/transform-field.js)_
558
710
  <!-- commandsstop -->