@saltcorn/cli 1.0.0-beta.1 → 1.0.0-beta.5
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 +394 -294
- package/bin/saltcorn +4 -4
- package/npm-shrinkwrap.json +11899 -29030
- package/oclif.manifest.json +1619 -1
- package/package.json +14 -25
- package/src/commands/add-schema.js +7 -8
- package/src/commands/backup.js +6 -6
- package/src/commands/build-app.js +26 -26
- package/src/commands/build-cordova-builder.js +3 -3
- package/src/commands/configuration-check-backups.js +7 -9
- package/src/commands/configuration-check.js +4 -5
- package/src/commands/create-tenant.js +11 -9
- package/src/commands/create-user.js +9 -10
- package/src/commands/delete-tenants.js +1 -1
- package/src/commands/delete-user.js +12 -10
- package/src/commands/dev/localize-plugin.js +12 -10
- package/src/commands/dev/make-migration.js +1 -1
- package/src/commands/dev/plugin-test.js +6 -6
- package/src/commands/dev/post-release.js +6 -7
- package/src/commands/dev/release.js +9 -6
- package/src/commands/dev/test-plugin.js +8 -5
- package/src/commands/fixtures.js +4 -4
- package/src/commands/get-cfg.js +14 -12
- package/src/commands/info.js +8 -8
- package/src/commands/inspect.js +9 -12
- package/src/commands/install-pack.js +5 -5
- package/src/commands/install-plugin.js +6 -6
- package/src/commands/list-tenants.js +27 -19
- package/src/commands/list-triggers.js +29 -18
- package/src/commands/list-users.js +9 -16
- package/src/commands/migrate.js +1 -1
- package/src/commands/modify-user.js +16 -15
- package/src/commands/plugins.js +7 -7
- package/src/commands/reset-schema.js +5 -6
- package/src/commands/restore.js +6 -6
- package/src/commands/rm-tenant.js +7 -9
- package/src/commands/run-benchmark.js +17 -14
- package/src/commands/run-js.js +5 -6
- package/src/commands/run-sql.js +5 -6
- package/src/commands/run-tests.js +15 -13
- package/src/commands/run-trigger.js +13 -8
- package/src/commands/scheduler.js +3 -3
- package/src/commands/serve.js +10 -10
- package/src/commands/set-cfg.js +14 -13
- package/src/commands/set-daily-time.js +7 -9
- package/src/commands/setup-benchmark.js +14 -7
- package/src/commands/setup.js +11 -12
- package/src/commands/sync-upload-data.js +6 -6
- package/src/commands/take-snapshot.js +5 -6
- package/src/commands/transform-field.js +9 -10
- package/src/index.js +1 -1
package/README.md
CHANGED
|
@@ -19,8 +19,8 @@ Saltcorn command line interface
|
|
|
19
19
|
$ npm install -g @saltcorn/cli
|
|
20
20
|
$ saltcorn COMMAND
|
|
21
21
|
running command...
|
|
22
|
-
$ saltcorn (
|
|
23
|
-
@saltcorn/cli/1.0.0-beta.
|
|
22
|
+
$ saltcorn (--version)
|
|
23
|
+
@saltcorn/cli/1.0.0-beta.5 linux-x64 node-v18.19.0
|
|
24
24
|
$ saltcorn --help [COMMAND]
|
|
25
25
|
USAGE
|
|
26
26
|
$ saltcorn COMMAND
|
|
@@ -49,7 +49,6 @@ USAGE
|
|
|
49
49
|
* [`saltcorn dev:test-plugin PATH`](#saltcorn-devtest-plugin-path)
|
|
50
50
|
* [`saltcorn fixtures`](#saltcorn-fixtures)
|
|
51
51
|
* [`saltcorn get-cfg [KEY]`](#saltcorn-get-cfg-key)
|
|
52
|
-
* [`saltcorn help [COMMAND]`](#saltcorn-help-command)
|
|
53
52
|
* [`saltcorn info`](#saltcorn-info)
|
|
54
53
|
* [`saltcorn inspect TYPE [NAME]`](#saltcorn-inspect-type-name)
|
|
55
54
|
* [`saltcorn install-pack`](#saltcorn-install-pack)
|
|
@@ -59,6 +58,7 @@ USAGE
|
|
|
59
58
|
* [`saltcorn list-users`](#saltcorn-list-users)
|
|
60
59
|
* [`saltcorn saltcorn migrate`](#saltcorn-saltcorn-migrate)
|
|
61
60
|
* [`saltcorn modify-user USER_EMAIL`](#saltcorn-modify-user-user_email)
|
|
61
|
+
* [`saltcorn paths`](#saltcorn-paths)
|
|
62
62
|
* [`saltcorn plugins`](#saltcorn-plugins)
|
|
63
63
|
* [`saltcorn reset-schema`](#saltcorn-reset-schema)
|
|
64
64
|
* [`saltcorn restore FILE`](#saltcorn-restore-file)
|
|
@@ -84,13 +84,16 @@ Add Saltcorn schema to existing database
|
|
|
84
84
|
|
|
85
85
|
```
|
|
86
86
|
USAGE
|
|
87
|
-
$ saltcorn add-schema
|
|
87
|
+
$ saltcorn add-schema [-f]
|
|
88
88
|
|
|
89
|
-
|
|
89
|
+
FLAGS
|
|
90
90
|
-f, --force force command execution
|
|
91
|
+
|
|
92
|
+
DESCRIPTION
|
|
93
|
+
Add Saltcorn schema to existing database
|
|
91
94
|
```
|
|
92
95
|
|
|
93
|
-
_See code: [src/commands/add-schema.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
96
|
+
_See code: [src/commands/add-schema.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/add-schema.js)_
|
|
94
97
|
|
|
95
98
|
## `saltcorn backup`
|
|
96
99
|
|
|
@@ -98,16 +101,19 @@ Backup the PostgreSQL database to a file with pg_dump or saltcorn backup zip
|
|
|
98
101
|
|
|
99
102
|
```
|
|
100
103
|
USAGE
|
|
101
|
-
$ saltcorn backup
|
|
104
|
+
$ saltcorn backup [-v] [-o <value>] [-t <value>] [-z]
|
|
102
105
|
|
|
103
|
-
|
|
104
|
-
-o, --output
|
|
105
|
-
-t, --tenant
|
|
106
|
-
-v, --verbose
|
|
107
|
-
-z, --zip
|
|
106
|
+
FLAGS
|
|
107
|
+
-o, --output=<value> output filename
|
|
108
|
+
-t, --tenant=<value> Backup tenant in saltcorn zip format
|
|
109
|
+
-v, --verbose Verbose
|
|
110
|
+
-z, --zip Backup public in saltcorn zip format
|
|
111
|
+
|
|
112
|
+
DESCRIPTION
|
|
113
|
+
Backup the PostgreSQL database to a file with pg_dump or saltcorn backup zip
|
|
108
114
|
```
|
|
109
115
|
|
|
110
|
-
_See code: [src/commands/backup.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
116
|
+
_See code: [src/commands/backup.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/backup.js)_
|
|
111
117
|
|
|
112
118
|
## `saltcorn build-app`
|
|
113
119
|
|
|
@@ -115,66 +121,46 @@ Build mobile app
|
|
|
115
121
|
|
|
116
122
|
```
|
|
117
123
|
USAGE
|
|
118
|
-
$ saltcorn build-app
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
-
|
|
127
|
-
|
|
128
|
-
-e, --entryPoint
|
|
129
|
-
|
|
130
|
-
-
|
|
131
|
-
|
|
132
|
-
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
--
|
|
144
|
-
|
|
145
|
-
--
|
|
146
|
-
|
|
124
|
+
$ saltcorn build-app [--tenantAppName <value>] [-p <value>] [-e <value>] [-t <value>] [-l <value>]
|
|
125
|
+
[--synchedTables <value>] [--includedPlugins <value>] [-d] [-b <value>] [-c <value>] [-u <value>] [--appName
|
|
126
|
+
<value>] [--appId <value>] [--appVersion <value>] [--appIcon <value>] [-s <value>] [--splashPage <value>]
|
|
127
|
+
[--autoPublicLogin] [--allowOfflineMode] [--provisioningProfile <value>] [--buildType <value>] [--androidKeystore
|
|
128
|
+
<value>] [--androidKeyStoreAlias <value>] [--androidKeystorePassword <value>]
|
|
129
|
+
|
|
130
|
+
FLAGS
|
|
131
|
+
-b, --buildDirectory=<value> A directory where the app should be build
|
|
132
|
+
-c, --copyAppDirectory=<value> If set, the app file will be copied here, please set 'user email', too
|
|
133
|
+
-d, --useDocker Use a docker container to build the app.
|
|
134
|
+
-e, --entryPoint=<value> This is the first view or page (see -t) after the login.
|
|
135
|
+
-l, --localUserTables=<value>... user defined tables that should be replicated into the app
|
|
136
|
+
-p, --platforms=<value>... Platforms to build for, space separated list
|
|
137
|
+
-s, --serverURL=<value> URL to a saltcorn server
|
|
138
|
+
-t, --entryPointType=<value> Type of the entry point ('view' or 'page'). The default is 'view'.
|
|
139
|
+
-u, --userEmail=<value> Email of the user building the app
|
|
140
|
+
--allowOfflineMode Switch to offline mode when there is no internet, sync the data when a connection
|
|
141
|
+
is available again.
|
|
142
|
+
--androidKeyStoreAlias=<value> A unique name to identify the key within the keystore file.
|
|
143
|
+
--androidKeystore=<value> A self-signed certificate that includes the private key used to sign your app.
|
|
144
|
+
--androidKeystorePassword=<value> he password to access the keystore file.
|
|
145
|
+
--appIcon=<value> A png that will be used as launcher icon. The default is a png of a saltcorn
|
|
146
|
+
symbol.
|
|
147
|
+
--appId=<value> Id of the mobile app (default com.saltcorn.mobileapp)
|
|
148
|
+
--appName=<value> Name of the mobile app (default SaltcornMobileApp)
|
|
149
|
+
--appVersion=<value> Version of the mobile app (default 1.0.0)
|
|
150
|
+
--autoPublicLogin Show public entry points before the login as a public user.
|
|
151
|
+
--buildType=<value> debug or release build
|
|
152
|
+
--includedPlugins=<value>... Names of plugins that should be bundled into the app.If empty, no modules are used.
|
|
153
|
+
--provisioningProfile=<value> This profile will be used to sign your app
|
|
154
|
+
--splashPage=<value> Name of a page that should be shown while the app is loading.
|
|
155
|
+
--synchedTables=<value>... Table names for which the offline should be synchronized with the saltcorn server
|
|
156
|
+
--tenantAppName=<value> Optional name of a tenant application, if set, the app will be build for this
|
|
157
|
+
tenant
|
|
147
158
|
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
--appIcon=appIcon A png that will be used as launcher icon. The default is a png of a
|
|
151
|
-
saltcorn symbol.
|
|
152
|
-
|
|
153
|
-
--appId=appId Id of the mobile app (default com.saltcorn.mobileapp)
|
|
154
|
-
|
|
155
|
-
--appName=appName Name of the mobile app (default SaltcornMobileApp)
|
|
156
|
-
|
|
157
|
-
--appVersion=appVersion Version of the mobile app (default 1.0.0)
|
|
158
|
-
|
|
159
|
-
--autoPublicLogin Show public entry points before the login as a public user.
|
|
160
|
-
|
|
161
|
-
--buildType=buildType debug or release build
|
|
162
|
-
|
|
163
|
-
--includedPlugins=includedPlugins Names of plugins that should be bundled into the app.If empty, no
|
|
164
|
-
modules are used.
|
|
165
|
-
|
|
166
|
-
--provisioningProfile=provisioningProfile This profile will be used to sign your app
|
|
167
|
-
|
|
168
|
-
--splashPage=splashPage Name of a page that should be shown while the app is loading.
|
|
169
|
-
|
|
170
|
-
--synchedTables=synchedTables Table names for which the offline should be synchronized with the
|
|
171
|
-
saltcorn server
|
|
172
|
-
|
|
173
|
-
--tenantAppName=tenantAppName Optional name of a tenant application, if set, the app will be
|
|
174
|
-
build for this tenant
|
|
159
|
+
DESCRIPTION
|
|
160
|
+
Build mobile app
|
|
175
161
|
```
|
|
176
162
|
|
|
177
|
-
_See code: [src/commands/build-app.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
163
|
+
_See code: [src/commands/build-app.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/build-app.js)_
|
|
178
164
|
|
|
179
165
|
## `saltcorn build-cordova-builder`
|
|
180
166
|
|
|
@@ -182,13 +168,16 @@ Build the 'saltcorn/cordova-builder' docker image
|
|
|
182
168
|
|
|
183
169
|
```
|
|
184
170
|
USAGE
|
|
185
|
-
$ saltcorn build-cordova-builder
|
|
171
|
+
$ saltcorn build-cordova-builder [--buildClean]
|
|
186
172
|
|
|
187
|
-
|
|
173
|
+
FLAGS
|
|
188
174
|
--buildClean run a clean build with --no-cache
|
|
175
|
+
|
|
176
|
+
DESCRIPTION
|
|
177
|
+
Build the 'saltcorn/cordova-builder' docker image
|
|
189
178
|
```
|
|
190
179
|
|
|
191
|
-
_See code: [src/commands/build-cordova-builder.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
180
|
+
_See code: [src/commands/build-cordova-builder.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/build-cordova-builder.js)_
|
|
192
181
|
|
|
193
182
|
## `saltcorn configuration-check`
|
|
194
183
|
|
|
@@ -196,13 +185,16 @@ Check configuration
|
|
|
196
185
|
|
|
197
186
|
```
|
|
198
187
|
USAGE
|
|
199
|
-
$ saltcorn configuration-check
|
|
188
|
+
$ saltcorn configuration-check [-t <value>]
|
|
189
|
+
|
|
190
|
+
FLAGS
|
|
191
|
+
-t, --tenant=<value> tenant
|
|
200
192
|
|
|
201
|
-
|
|
202
|
-
|
|
193
|
+
DESCRIPTION
|
|
194
|
+
Check configuration
|
|
203
195
|
```
|
|
204
196
|
|
|
205
|
-
_See code: [src/commands/configuration-check.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
197
|
+
_See code: [src/commands/configuration-check.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/configuration-check.js)_
|
|
206
198
|
|
|
207
199
|
## `saltcorn configuration-check-backups FILES`
|
|
208
200
|
|
|
@@ -210,16 +202,19 @@ Check configuration
|
|
|
210
202
|
|
|
211
203
|
```
|
|
212
204
|
USAGE
|
|
213
|
-
$ saltcorn configuration-check-backups FILES
|
|
205
|
+
$ saltcorn configuration-check-backups FILES [-d]
|
|
214
206
|
|
|
215
207
|
ARGUMENTS
|
|
216
208
|
FILES backup file to check. can be repeated, e.g. with *
|
|
217
209
|
|
|
218
|
-
|
|
210
|
+
FLAGS
|
|
219
211
|
-d, --destructive destructive
|
|
212
|
+
|
|
213
|
+
DESCRIPTION
|
|
214
|
+
Check configuration
|
|
220
215
|
```
|
|
221
216
|
|
|
222
|
-
_See code: [src/commands/configuration-check-backups.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
217
|
+
_See code: [src/commands/configuration-check-backups.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/configuration-check-backups.js)_
|
|
223
218
|
|
|
224
219
|
## `saltcorn create-tenant TENANT`
|
|
225
220
|
|
|
@@ -227,18 +222,21 @@ Create a tenant
|
|
|
227
222
|
|
|
228
223
|
```
|
|
229
224
|
USAGE
|
|
230
|
-
$ saltcorn create-tenant TENANT
|
|
225
|
+
$ saltcorn create-tenant TENANT [--url <value>] [-e <value>] [-d <value>]
|
|
231
226
|
|
|
232
227
|
ARGUMENTS
|
|
233
228
|
TENANT Tenant subdomain to create
|
|
234
229
|
|
|
235
|
-
|
|
236
|
-
-d, --description
|
|
237
|
-
-e, --email
|
|
238
|
-
--url
|
|
230
|
+
FLAGS
|
|
231
|
+
-d, --description=<value> Description of tenant
|
|
232
|
+
-e, --email=<value> Email of owner of tenant
|
|
233
|
+
--url=<value> Url of tenant
|
|
234
|
+
|
|
235
|
+
DESCRIPTION
|
|
236
|
+
Create a tenant
|
|
239
237
|
```
|
|
240
238
|
|
|
241
|
-
_See code: [src/commands/create-tenant.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
239
|
+
_See code: [src/commands/create-tenant.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/create-tenant.js)_
|
|
242
240
|
|
|
243
241
|
## `saltcorn create-user`
|
|
244
242
|
|
|
@@ -246,17 +244,20 @@ Create a new user
|
|
|
246
244
|
|
|
247
245
|
```
|
|
248
246
|
USAGE
|
|
249
|
-
$ saltcorn create-user
|
|
247
|
+
$ saltcorn create-user [-a] [-t <value>] [-e <value>] [-r <value>] [-p <value>]
|
|
248
|
+
|
|
249
|
+
FLAGS
|
|
250
|
+
-a, --admin Admin user
|
|
251
|
+
-e, --email=<value> email
|
|
252
|
+
-p, --password=<value> password
|
|
253
|
+
-r, --role=<value> role
|
|
254
|
+
-t, --tenant=<value> tenant
|
|
250
255
|
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
-e, --email=email email
|
|
254
|
-
-p, --password=password password
|
|
255
|
-
-r, --role=role role
|
|
256
|
-
-t, --tenant=tenant tenant
|
|
256
|
+
DESCRIPTION
|
|
257
|
+
Create a new user
|
|
257
258
|
```
|
|
258
259
|
|
|
259
|
-
_See code: [src/commands/create-user.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
260
|
+
_See code: [src/commands/create-user.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/create-user.js)_
|
|
260
261
|
|
|
261
262
|
## `saltcorn delete-tenants`
|
|
262
263
|
|
|
@@ -265,9 +266,12 @@ Delete inactive tenants
|
|
|
265
266
|
```
|
|
266
267
|
USAGE
|
|
267
268
|
$ saltcorn delete-tenants
|
|
269
|
+
|
|
270
|
+
DESCRIPTION
|
|
271
|
+
Delete inactive tenants
|
|
268
272
|
```
|
|
269
273
|
|
|
270
|
-
_See code: [src/commands/delete-tenants.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
274
|
+
_See code: [src/commands/delete-tenants.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/delete-tenants.js)_
|
|
271
275
|
|
|
272
276
|
## `saltcorn delete-user USER_EMAIL`
|
|
273
277
|
|
|
@@ -275,20 +279,22 @@ Delete user.
|
|
|
275
279
|
|
|
276
280
|
```
|
|
277
281
|
USAGE
|
|
278
|
-
$ saltcorn delete-user USER_EMAIL
|
|
282
|
+
$ saltcorn delete-user USER_EMAIL [-f] [-t <value>]
|
|
279
283
|
|
|
280
284
|
ARGUMENTS
|
|
281
285
|
USER_EMAIL User to delete
|
|
282
286
|
|
|
283
|
-
|
|
284
|
-
-f, --force
|
|
285
|
-
-t, --tenant
|
|
287
|
+
FLAGS
|
|
288
|
+
-f, --force force command execution
|
|
289
|
+
-t, --tenant=<value> tenant
|
|
286
290
|
|
|
287
291
|
DESCRIPTION
|
|
292
|
+
Delete user.
|
|
293
|
+
|
|
288
294
|
Command deletes the user specified by USER_EMAIL.
|
|
289
295
|
```
|
|
290
296
|
|
|
291
|
-
_See code: [src/commands/delete-user.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
297
|
+
_See code: [src/commands/delete-user.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/delete-user.js)_
|
|
292
298
|
|
|
293
299
|
## `saltcorn dev:localize-plugin PLUGIN [PATH]`
|
|
294
300
|
|
|
@@ -296,18 +302,21 @@ Convert plugin to local plugin
|
|
|
296
302
|
|
|
297
303
|
```
|
|
298
304
|
USAGE
|
|
299
|
-
$ saltcorn dev:localize-plugin PLUGIN [PATH]
|
|
305
|
+
$ saltcorn dev:localize-plugin PLUGIN [PATH] [-u] [-t <value>]
|
|
300
306
|
|
|
301
307
|
ARGUMENTS
|
|
302
308
|
PLUGIN Current plugin name
|
|
303
309
|
PATH Absolute path to local plugin
|
|
304
310
|
|
|
305
|
-
|
|
306
|
-
-t, --tenant
|
|
307
|
-
-u, --unlocalize
|
|
311
|
+
FLAGS
|
|
312
|
+
-t, --tenant=<value> tenant
|
|
313
|
+
-u, --unlocalize Unlocalize plugin (local to npm)
|
|
314
|
+
|
|
315
|
+
DESCRIPTION
|
|
316
|
+
Convert plugin to local plugin
|
|
308
317
|
```
|
|
309
318
|
|
|
310
|
-
_See code: [src/commands/dev/localize-plugin.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
319
|
+
_See code: [src/commands/dev/localize-plugin.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/dev/localize-plugin.js)_
|
|
311
320
|
|
|
312
321
|
## `saltcorn make-migration`
|
|
313
322
|
|
|
@@ -318,12 +327,13 @@ USAGE
|
|
|
318
327
|
$ saltcorn make-migration
|
|
319
328
|
|
|
320
329
|
DESCRIPTION
|
|
330
|
+
Create a new blank Database structure migration file.
|
|
321
331
|
These migrations update database structure.
|
|
322
332
|
You should not normally need to run this
|
|
323
333
|
unless you are a developer.
|
|
324
334
|
```
|
|
325
335
|
|
|
326
|
-
_See code: [src/commands/dev/make-migration.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
336
|
+
_See code: [src/commands/dev/make-migration.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/dev/make-migration.js)_
|
|
327
337
|
|
|
328
338
|
## `saltcorn saltcorn dev:plugin-test -d [PATH_TO_LOCAL_PLUGIN]/statistics -f test-backup.zip`
|
|
329
339
|
|
|
@@ -333,18 +343,18 @@ Install a plugin, spawn 'npm run test' in the install directory and check the re
|
|
|
333
343
|
USAGE
|
|
334
344
|
$ saltcorn saltcorn dev:plugin-test -d [PATH_TO_LOCAL_PLUGIN]/statistics -f test-backup.zip
|
|
335
345
|
|
|
336
|
-
|
|
337
|
-
-d, --directory
|
|
346
|
+
FLAGS
|
|
347
|
+
-d, --directory=<value> Directory of local plugin
|
|
348
|
+
-f, --backupFile=<value> Optional name of a backup file in the tests folder. If you ommit this, then the test has to
|
|
349
|
+
create its own data.
|
|
350
|
+
-n, --name=<value> Plugin name in store of a released plugin
|
|
351
|
+
--database=<value> Run on specified database. Default is 'saltcorn_test''
|
|
338
352
|
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
-n, --name=name Plugin name in store of a released plugin
|
|
343
|
-
|
|
344
|
-
--database=database Run on specified database. Default is 'saltcorn_test''
|
|
353
|
+
DESCRIPTION
|
|
354
|
+
Install a plugin, spawn 'npm run test' in the install directory and check the return code.
|
|
345
355
|
```
|
|
346
356
|
|
|
347
|
-
_See code: [src/commands/dev/plugin-test.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
357
|
+
_See code: [src/commands/dev/plugin-test.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/dev/plugin-test.js)_
|
|
348
358
|
|
|
349
359
|
## `saltcorn dev:post-release [TASK]`
|
|
350
360
|
|
|
@@ -356,9 +366,12 @@ USAGE
|
|
|
356
366
|
|
|
357
367
|
ARGUMENTS
|
|
358
368
|
TASK (docker|vagrant|all|none) What to do
|
|
369
|
+
|
|
370
|
+
DESCRIPTION
|
|
371
|
+
Post-release tasks: docker and vagrant builds
|
|
359
372
|
```
|
|
360
373
|
|
|
361
|
-
_See code: [src/commands/dev/post-release.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
374
|
+
_See code: [src/commands/dev/post-release.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/dev/post-release.js)_
|
|
362
375
|
|
|
363
376
|
## `saltcorn dev:release VERSION`
|
|
364
377
|
|
|
@@ -366,16 +379,19 @@ Release a new saltcorn version
|
|
|
366
379
|
|
|
367
380
|
```
|
|
368
381
|
USAGE
|
|
369
|
-
$ saltcorn dev:release VERSION
|
|
382
|
+
$ saltcorn dev:release VERSION [-t <value>]
|
|
370
383
|
|
|
371
384
|
ARGUMENTS
|
|
372
385
|
VERSION New version number
|
|
373
386
|
|
|
374
|
-
|
|
375
|
-
-t, --tag
|
|
387
|
+
FLAGS
|
|
388
|
+
-t, --tag=<value> NPM tag
|
|
389
|
+
|
|
390
|
+
DESCRIPTION
|
|
391
|
+
Release a new saltcorn version
|
|
376
392
|
```
|
|
377
393
|
|
|
378
|
-
_See code: [src/commands/dev/release.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
394
|
+
_See code: [src/commands/dev/release.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/dev/release.js)_
|
|
379
395
|
|
|
380
396
|
## `saltcorn dev:test-plugin PATH`
|
|
381
397
|
|
|
@@ -389,11 +405,12 @@ ARGUMENTS
|
|
|
389
405
|
PATH path to plugin package
|
|
390
406
|
|
|
391
407
|
DESCRIPTION
|
|
408
|
+
Test a plugin
|
|
392
409
|
...
|
|
393
410
|
Extra documentation goes here
|
|
394
411
|
```
|
|
395
412
|
|
|
396
|
-
_See code: [src/commands/dev/test-plugin.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
413
|
+
_See code: [src/commands/dev/test-plugin.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/dev/test-plugin.js)_
|
|
397
414
|
|
|
398
415
|
## `saltcorn fixtures`
|
|
399
416
|
|
|
@@ -401,18 +418,19 @@ Load fixtures for testing
|
|
|
401
418
|
|
|
402
419
|
```
|
|
403
420
|
USAGE
|
|
404
|
-
$ saltcorn fixtures
|
|
421
|
+
$ saltcorn fixtures [-r] [-t <value>]
|
|
405
422
|
|
|
406
|
-
|
|
407
|
-
-r, --reset
|
|
408
|
-
-t, --tenant
|
|
423
|
+
FLAGS
|
|
424
|
+
-r, --reset Also reset schema
|
|
425
|
+
-t, --tenant=<value> tenant
|
|
409
426
|
|
|
410
427
|
DESCRIPTION
|
|
428
|
+
Load fixtures for testing
|
|
411
429
|
...
|
|
412
430
|
This manual step it is never required for users and rarely required for developers
|
|
413
431
|
```
|
|
414
432
|
|
|
415
|
-
_See code: [src/commands/fixtures.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
433
|
+
_See code: [src/commands/fixtures.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/fixtures.js)_
|
|
416
434
|
|
|
417
435
|
## `saltcorn get-cfg [KEY]`
|
|
418
436
|
|
|
@@ -420,34 +438,20 @@ Get a configuration value. The value is printed to stdout as a JSON value
|
|
|
420
438
|
|
|
421
439
|
```
|
|
422
440
|
USAGE
|
|
423
|
-
$ saltcorn get-cfg [KEY]
|
|
441
|
+
$ saltcorn get-cfg [KEY] [-t <value>] [-p <value>]
|
|
424
442
|
|
|
425
443
|
ARGUMENTS
|
|
426
444
|
KEY Configuration key
|
|
427
445
|
|
|
428
|
-
|
|
429
|
-
-p, --plugin
|
|
430
|
-
-t, --tenant
|
|
431
|
-
```
|
|
432
|
-
|
|
433
|
-
_See code: [src/commands/get-cfg.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.1/packages/saltcorn-cli/src/commands/get-cfg.js)_
|
|
434
|
-
|
|
435
|
-
## `saltcorn help [COMMAND]`
|
|
436
|
-
|
|
437
|
-
display help for saltcorn
|
|
446
|
+
FLAGS
|
|
447
|
+
-p, --plugin=<value> plugin
|
|
448
|
+
-t, --tenant=<value> tenant
|
|
438
449
|
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
$ saltcorn help [COMMAND]
|
|
442
|
-
|
|
443
|
-
ARGUMENTS
|
|
444
|
-
COMMAND command to show help for
|
|
445
|
-
|
|
446
|
-
OPTIONS
|
|
447
|
-
--all see all commands in CLI
|
|
450
|
+
DESCRIPTION
|
|
451
|
+
Get a configuration value. The value is printed to stdout as a JSON value
|
|
448
452
|
```
|
|
449
453
|
|
|
450
|
-
_See code: [
|
|
454
|
+
_See code: [src/commands/get-cfg.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/get-cfg.js)_
|
|
451
455
|
|
|
452
456
|
## `saltcorn info`
|
|
453
457
|
|
|
@@ -455,20 +459,22 @@ Show paths
|
|
|
455
459
|
|
|
456
460
|
```
|
|
457
461
|
USAGE
|
|
458
|
-
$ saltcorn info
|
|
462
|
+
$ saltcorn info [-j]
|
|
459
463
|
|
|
460
|
-
|
|
464
|
+
FLAGS
|
|
461
465
|
-j, --json json format
|
|
462
466
|
|
|
463
467
|
DESCRIPTION
|
|
468
|
+
Show paths
|
|
464
469
|
...
|
|
465
470
|
Show configuration and file store paths
|
|
466
471
|
|
|
472
|
+
|
|
467
473
|
ALIASES
|
|
468
474
|
$ saltcorn paths
|
|
469
475
|
```
|
|
470
476
|
|
|
471
|
-
_See code: [src/commands/info.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
477
|
+
_See code: [src/commands/info.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/info.js)_
|
|
472
478
|
|
|
473
479
|
## `saltcorn inspect TYPE [NAME]`
|
|
474
480
|
|
|
@@ -476,17 +482,20 @@ Inspect an entity's JSON representation, or list entities
|
|
|
476
482
|
|
|
477
483
|
```
|
|
478
484
|
USAGE
|
|
479
|
-
$ saltcorn inspect TYPE [NAME]
|
|
485
|
+
$ saltcorn inspect TYPE [NAME] [-t <value>]
|
|
480
486
|
|
|
481
487
|
ARGUMENTS
|
|
482
488
|
TYPE (view|page|trigger|table) Entity type
|
|
483
489
|
NAME Entity name. If not supplied, list all names
|
|
484
490
|
|
|
485
|
-
|
|
486
|
-
-t, --tenant
|
|
491
|
+
FLAGS
|
|
492
|
+
-t, --tenant=<value> tenant
|
|
493
|
+
|
|
494
|
+
DESCRIPTION
|
|
495
|
+
Inspect an entity's JSON representation, or list entities
|
|
487
496
|
```
|
|
488
497
|
|
|
489
|
-
_See code: [src/commands/inspect.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
498
|
+
_See code: [src/commands/inspect.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/inspect.js)_
|
|
490
499
|
|
|
491
500
|
## `saltcorn install-pack`
|
|
492
501
|
|
|
@@ -494,15 +503,18 @@ Install a pack or restore a snapshot
|
|
|
494
503
|
|
|
495
504
|
```
|
|
496
505
|
USAGE
|
|
497
|
-
$ saltcorn install-pack
|
|
506
|
+
$ saltcorn install-pack [-t <value>] [-n <value>] [-f <value>]
|
|
498
507
|
|
|
499
|
-
|
|
500
|
-
-f, --file
|
|
501
|
-
-n, --name
|
|
502
|
-
-t, --tenant
|
|
508
|
+
FLAGS
|
|
509
|
+
-f, --file=<value> File with pack JSON
|
|
510
|
+
-n, --name=<value> Pack name in store
|
|
511
|
+
-t, --tenant=<value> tenant
|
|
512
|
+
|
|
513
|
+
DESCRIPTION
|
|
514
|
+
Install a pack or restore a snapshot
|
|
503
515
|
```
|
|
504
516
|
|
|
505
|
-
_See code: [src/commands/install-pack.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
517
|
+
_See code: [src/commands/install-pack.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/install-pack.js)_
|
|
506
518
|
|
|
507
519
|
## `saltcorn install-plugin`
|
|
508
520
|
|
|
@@ -510,16 +522,19 @@ Install a plugin
|
|
|
510
522
|
|
|
511
523
|
```
|
|
512
524
|
USAGE
|
|
513
|
-
$ saltcorn install-plugin
|
|
525
|
+
$ saltcorn install-plugin [-t <value>] [-n <value>] [-d <value>] [-u]
|
|
514
526
|
|
|
515
|
-
|
|
516
|
-
-d, --directory
|
|
517
|
-
-n, --name
|
|
518
|
-
-t, --tenant
|
|
519
|
-
-u, --unsafe
|
|
527
|
+
FLAGS
|
|
528
|
+
-d, --directory=<value> Directory with local plugin
|
|
529
|
+
-n, --name=<value> Plugin name in store
|
|
530
|
+
-t, --tenant=<value> tenant
|
|
531
|
+
-u, --unsafe Allow unsafe plugins on tenants
|
|
532
|
+
|
|
533
|
+
DESCRIPTION
|
|
534
|
+
Install a plugin
|
|
520
535
|
```
|
|
521
536
|
|
|
522
|
-
_See code: [src/commands/install-plugin.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
537
|
+
_See code: [src/commands/install-plugin.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/install-plugin.js)_
|
|
523
538
|
|
|
524
539
|
## `saltcorn list-tenants`
|
|
525
540
|
|
|
@@ -527,15 +542,18 @@ List tenants in CSV format
|
|
|
527
542
|
|
|
528
543
|
```
|
|
529
544
|
USAGE
|
|
530
|
-
$ saltcorn list-tenants
|
|
545
|
+
$ saltcorn list-tenants [-t <value>] [-v] [-j]
|
|
531
546
|
|
|
532
|
-
|
|
533
|
-
-j, --json
|
|
534
|
-
-t, --tenant
|
|
535
|
-
-v, --verbose
|
|
547
|
+
FLAGS
|
|
548
|
+
-j, --json json format
|
|
549
|
+
-t, --tenant=<value> tenant
|
|
550
|
+
-v, --verbose verbose output
|
|
551
|
+
|
|
552
|
+
DESCRIPTION
|
|
553
|
+
List tenants in CSV format
|
|
536
554
|
```
|
|
537
555
|
|
|
538
|
-
_See code: [src/commands/list-tenants.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
556
|
+
_See code: [src/commands/list-tenants.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/list-tenants.js)_
|
|
539
557
|
|
|
540
558
|
## `saltcorn list-triggers`
|
|
541
559
|
|
|
@@ -543,15 +561,18 @@ List triggers
|
|
|
543
561
|
|
|
544
562
|
```
|
|
545
563
|
USAGE
|
|
546
|
-
$ saltcorn list-triggers
|
|
564
|
+
$ saltcorn list-triggers [-t <value>] [-v] [-j]
|
|
547
565
|
|
|
548
|
-
|
|
549
|
-
-j, --json
|
|
550
|
-
-t, --tenant
|
|
551
|
-
-v, --verbose
|
|
566
|
+
FLAGS
|
|
567
|
+
-j, --json json format
|
|
568
|
+
-t, --tenant=<value> tenant
|
|
569
|
+
-v, --verbose verbose output
|
|
570
|
+
|
|
571
|
+
DESCRIPTION
|
|
572
|
+
List triggers
|
|
552
573
|
```
|
|
553
574
|
|
|
554
|
-
_See code: [src/commands/list-triggers.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
575
|
+
_See code: [src/commands/list-triggers.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/list-triggers.js)_
|
|
555
576
|
|
|
556
577
|
## `saltcorn list-users`
|
|
557
578
|
|
|
@@ -559,14 +580,17 @@ List users
|
|
|
559
580
|
|
|
560
581
|
```
|
|
561
582
|
USAGE
|
|
562
|
-
$ saltcorn list-users
|
|
583
|
+
$ saltcorn list-users [-t <value>] [-v]
|
|
563
584
|
|
|
564
|
-
|
|
565
|
-
-t, --tenant
|
|
566
|
-
-v, --verbose
|
|
585
|
+
FLAGS
|
|
586
|
+
-t, --tenant=<value> tenant
|
|
587
|
+
-v, --verbose verbose output
|
|
588
|
+
|
|
589
|
+
DESCRIPTION
|
|
590
|
+
List users
|
|
567
591
|
```
|
|
568
592
|
|
|
569
|
-
_See code: [src/commands/list-users.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
593
|
+
_See code: [src/commands/list-users.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/list-users.js)_
|
|
570
594
|
|
|
571
595
|
## `saltcorn saltcorn migrate`
|
|
572
596
|
|
|
@@ -577,6 +601,7 @@ USAGE
|
|
|
577
601
|
$ saltcorn saltcorn migrate
|
|
578
602
|
|
|
579
603
|
DESCRIPTION
|
|
604
|
+
Run Database structure migrations
|
|
580
605
|
...
|
|
581
606
|
NOTE!
|
|
582
607
|
- Please stop Saltcorn before run DB migrations.
|
|
@@ -588,7 +613,7 @@ DESCRIPTION
|
|
|
588
613
|
servers and need to control when the migrations are run.
|
|
589
614
|
```
|
|
590
615
|
|
|
591
|
-
_See code: [src/commands/migrate.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
616
|
+
_See code: [src/commands/migrate.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/migrate.js)_
|
|
592
617
|
|
|
593
618
|
## `saltcorn modify-user USER_EMAIL`
|
|
594
619
|
|
|
@@ -596,20 +621,22 @@ Modify (update) user.
|
|
|
596
621
|
|
|
597
622
|
```
|
|
598
623
|
USAGE
|
|
599
|
-
$ saltcorn modify-user USER_EMAIL
|
|
624
|
+
$ saltcorn modify-user USER_EMAIL [-a] [-t <value>] [-e <value>] [-r <value>] [-p <value>] [-i]
|
|
600
625
|
|
|
601
626
|
ARGUMENTS
|
|
602
627
|
USER_EMAIL User to modify
|
|
603
628
|
|
|
604
|
-
|
|
605
|
-
-a, --admin
|
|
606
|
-
-e, --email
|
|
607
|
-
-i, --imode
|
|
608
|
-
-p, --password
|
|
609
|
-
-r, --role
|
|
610
|
-
-t, --tenant
|
|
629
|
+
FLAGS
|
|
630
|
+
-a, --admin make user be Admin
|
|
631
|
+
-e, --email=<value> new email
|
|
632
|
+
-i, --imode interactive mode
|
|
633
|
+
-p, --password=<value> new password
|
|
634
|
+
-r, --role=<value> new role (can conflict with -a option)
|
|
635
|
+
-t, --tenant=<value> tenant
|
|
611
636
|
|
|
612
637
|
DESCRIPTION
|
|
638
|
+
Modify (update) user.
|
|
639
|
+
|
|
613
640
|
Command changes the user specified by USER_EMAIL.
|
|
614
641
|
|
|
615
642
|
You can change the user group, password and email.
|
|
@@ -617,7 +644,28 @@ DESCRIPTION
|
|
|
617
644
|
NOTE that -a and -r role (--role=role) can give conflict.
|
|
618
645
|
```
|
|
619
646
|
|
|
620
|
-
_See code: [src/commands/modify-user.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
647
|
+
_See code: [src/commands/modify-user.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/modify-user.js)_
|
|
648
|
+
|
|
649
|
+
## `saltcorn paths`
|
|
650
|
+
|
|
651
|
+
Show paths
|
|
652
|
+
|
|
653
|
+
```
|
|
654
|
+
USAGE
|
|
655
|
+
$ saltcorn paths [-j]
|
|
656
|
+
|
|
657
|
+
FLAGS
|
|
658
|
+
-j, --json json format
|
|
659
|
+
|
|
660
|
+
DESCRIPTION
|
|
661
|
+
Show paths
|
|
662
|
+
...
|
|
663
|
+
Show configuration and file store paths
|
|
664
|
+
|
|
665
|
+
|
|
666
|
+
ALIASES
|
|
667
|
+
$ saltcorn paths
|
|
668
|
+
```
|
|
621
669
|
|
|
622
670
|
## `saltcorn plugins`
|
|
623
671
|
|
|
@@ -625,26 +673,30 @@ List and upgrade plugins for tenants
|
|
|
625
673
|
|
|
626
674
|
```
|
|
627
675
|
USAGE
|
|
628
|
-
$ saltcorn plugins
|
|
676
|
+
$ saltcorn plugins [-u] [-d] [-v] [-f] [-n <value>]
|
|
629
677
|
|
|
630
|
-
|
|
631
|
-
-d, --dryRun
|
|
632
|
-
-f, --force
|
|
633
|
-
-n, --name
|
|
634
|
-
-u, --upgrade
|
|
635
|
-
-v, --verbose
|
|
678
|
+
FLAGS
|
|
679
|
+
-d, --dryRun Upgrade dry-run
|
|
680
|
+
-f, --force Force update
|
|
681
|
+
-n, --name=<value> Plugin name
|
|
682
|
+
-u, --upgrade Upgrade
|
|
683
|
+
-v, --verbose Verbose output
|
|
636
684
|
|
|
637
685
|
DESCRIPTION
|
|
686
|
+
List and upgrade plugins for tenants
|
|
638
687
|
...
|
|
639
688
|
Extra documentation goes here
|
|
640
689
|
|
|
690
|
+
|
|
641
691
|
EXAMPLES
|
|
642
692
|
plugins -v - verbose output of commands
|
|
693
|
+
|
|
643
694
|
plugins -u -d - dry-run for plugin update
|
|
695
|
+
|
|
644
696
|
plugins -u -f - force plugin update
|
|
645
697
|
```
|
|
646
698
|
|
|
647
|
-
_See code: [src/commands/plugins.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
699
|
+
_See code: [src/commands/plugins.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/plugins.js)_
|
|
648
700
|
|
|
649
701
|
## `saltcorn reset-schema`
|
|
650
702
|
|
|
@@ -652,18 +704,19 @@ Reset the database
|
|
|
652
704
|
|
|
653
705
|
```
|
|
654
706
|
USAGE
|
|
655
|
-
$ saltcorn reset-schema
|
|
707
|
+
$ saltcorn reset-schema [-f] [-t <value>]
|
|
656
708
|
|
|
657
|
-
|
|
658
|
-
-f, --force
|
|
659
|
-
-t, --tenant
|
|
709
|
+
FLAGS
|
|
710
|
+
-f, --force force command execution
|
|
711
|
+
-t, --tenant=<value> tenant
|
|
660
712
|
|
|
661
713
|
DESCRIPTION
|
|
714
|
+
Reset the database
|
|
662
715
|
...
|
|
663
716
|
This will delete all existing information
|
|
664
717
|
```
|
|
665
718
|
|
|
666
|
-
_See code: [src/commands/reset-schema.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
719
|
+
_See code: [src/commands/reset-schema.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/reset-schema.js)_
|
|
667
720
|
|
|
668
721
|
## `saltcorn restore FILE`
|
|
669
722
|
|
|
@@ -671,16 +724,19 @@ Restore a previously backed up database (zip or sqlc format)
|
|
|
671
724
|
|
|
672
725
|
```
|
|
673
726
|
USAGE
|
|
674
|
-
$ saltcorn restore FILE
|
|
727
|
+
$ saltcorn restore FILE [-t <value>]
|
|
675
728
|
|
|
676
729
|
ARGUMENTS
|
|
677
730
|
FILE backup file to restore
|
|
678
731
|
|
|
679
|
-
|
|
680
|
-
-t, --tenant
|
|
732
|
+
FLAGS
|
|
733
|
+
-t, --tenant=<value> tenant
|
|
734
|
+
|
|
735
|
+
DESCRIPTION
|
|
736
|
+
Restore a previously backed up database (zip or sqlc format)
|
|
681
737
|
```
|
|
682
738
|
|
|
683
|
-
_See code: [src/commands/restore.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
739
|
+
_See code: [src/commands/restore.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/restore.js)_
|
|
684
740
|
|
|
685
741
|
## `saltcorn rm-tenant`
|
|
686
742
|
|
|
@@ -688,18 +744,19 @@ Remove a tenant.
|
|
|
688
744
|
|
|
689
745
|
```
|
|
690
746
|
USAGE
|
|
691
|
-
$ saltcorn rm-tenant
|
|
747
|
+
$ saltcorn rm-tenant -t <value> [-f]
|
|
692
748
|
|
|
693
|
-
|
|
694
|
-
-f, --force
|
|
695
|
-
-t, --tenant
|
|
749
|
+
FLAGS
|
|
750
|
+
-f, --force force command execution
|
|
751
|
+
-t, --tenant=<value> (required) tenant
|
|
696
752
|
|
|
697
753
|
DESCRIPTION
|
|
754
|
+
Remove a tenant.
|
|
698
755
|
Attention! All tenant data will be lost!
|
|
699
756
|
It recommended to make backup of tenant before perform this command.
|
|
700
757
|
```
|
|
701
758
|
|
|
702
|
-
_See code: [src/commands/rm-tenant.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
759
|
+
_See code: [src/commands/rm-tenant.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/rm-tenant.js)_
|
|
703
760
|
|
|
704
761
|
## `saltcorn run-benchmark [BASEURL]`
|
|
705
762
|
|
|
@@ -707,18 +764,21 @@ Run benchmark
|
|
|
707
764
|
|
|
708
765
|
```
|
|
709
766
|
USAGE
|
|
710
|
-
$ saltcorn run-benchmark [BASEURL]
|
|
767
|
+
$ saltcorn run-benchmark [BASEURL] [-t <value>] [-b <value>] [-d <value>]
|
|
711
768
|
|
|
712
769
|
ARGUMENTS
|
|
713
770
|
BASEURL Base URL
|
|
714
771
|
|
|
715
|
-
|
|
716
|
-
-b, --benchmark
|
|
717
|
-
-d, --delay
|
|
718
|
-
-t, --token
|
|
772
|
+
FLAGS
|
|
773
|
+
-b, --benchmark=<value> Which benchmark to run
|
|
774
|
+
-d, --delay=<value> [default: 30] delay between runs (s)
|
|
775
|
+
-t, --token=<value> API Token for reporting results
|
|
776
|
+
|
|
777
|
+
DESCRIPTION
|
|
778
|
+
Run benchmark
|
|
719
779
|
```
|
|
720
780
|
|
|
721
|
-
_See code: [src/commands/run-benchmark.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
781
|
+
_See code: [src/commands/run-benchmark.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/run-benchmark.js)_
|
|
722
782
|
|
|
723
783
|
## `saltcorn run-js`
|
|
724
784
|
|
|
@@ -726,15 +786,18 @@ Run javascript code
|
|
|
726
786
|
|
|
727
787
|
```
|
|
728
788
|
USAGE
|
|
729
|
-
$ saltcorn run-js
|
|
789
|
+
$ saltcorn run-js [-t <value>] [-c <value>] [-f <value>]
|
|
790
|
+
|
|
791
|
+
FLAGS
|
|
792
|
+
-c, --code=<value> js code
|
|
793
|
+
-f, --file=<value> path to script file
|
|
794
|
+
-t, --tenant=<value> tenant name
|
|
730
795
|
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
-f, --file=file path to script file
|
|
734
|
-
-t, --tenant=tenant tenant name
|
|
796
|
+
DESCRIPTION
|
|
797
|
+
Run javascript code
|
|
735
798
|
```
|
|
736
799
|
|
|
737
|
-
_See code: [src/commands/run-js.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
800
|
+
_See code: [src/commands/run-js.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/run-js.js)_
|
|
738
801
|
|
|
739
802
|
## `saltcorn run-sql`
|
|
740
803
|
|
|
@@ -742,15 +805,18 @@ Run sql expression
|
|
|
742
805
|
|
|
743
806
|
```
|
|
744
807
|
USAGE
|
|
745
|
-
$ saltcorn run-sql
|
|
808
|
+
$ saltcorn run-sql [-t <value>] [-s <value>] [-f <value>]
|
|
809
|
+
|
|
810
|
+
FLAGS
|
|
811
|
+
-f, --file=<value> path to sql file name
|
|
812
|
+
-s, --sql=<value> sql statement
|
|
813
|
+
-t, --tenant=<value> tenant name
|
|
746
814
|
|
|
747
|
-
|
|
748
|
-
|
|
749
|
-
-s, --sql=sql sql statement
|
|
750
|
-
-t, --tenant=tenant tenant name
|
|
815
|
+
DESCRIPTION
|
|
816
|
+
Run sql expression
|
|
751
817
|
```
|
|
752
818
|
|
|
753
|
-
_See code: [src/commands/run-sql.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
819
|
+
_See code: [src/commands/run-sql.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/run-sql.js)_
|
|
754
820
|
|
|
755
821
|
## `saltcorn run-tests [PACKAGE]`
|
|
756
822
|
|
|
@@ -758,23 +824,26 @@ Run test suites
|
|
|
758
824
|
|
|
759
825
|
```
|
|
760
826
|
USAGE
|
|
761
|
-
$ saltcorn run-tests [PACKAGE]
|
|
827
|
+
$ saltcorn run-tests [PACKAGE] [-c] [-l] [-v] [-d] [-t <value>] [--watch] [--watchAll] [--database <value>]
|
|
762
828
|
|
|
763
829
|
ARGUMENTS
|
|
764
830
|
PACKAGE which package to run tests for
|
|
765
831
|
|
|
766
|
-
|
|
767
|
-
-c, --coverage
|
|
768
|
-
-d, --detectOpenHandles
|
|
769
|
-
-l, --listTests
|
|
770
|
-
-t, --testFilter
|
|
771
|
-
-v, --verbose
|
|
772
|
-
--database
|
|
773
|
-
--watch
|
|
774
|
-
--watchAll
|
|
832
|
+
FLAGS
|
|
833
|
+
-c, --coverage Coverage
|
|
834
|
+
-d, --detectOpenHandles Detect Open Handles
|
|
835
|
+
-l, --listTests List tests
|
|
836
|
+
-t, --testFilter=<value> Filter tests by suite or test name
|
|
837
|
+
-v, --verbose Verbose
|
|
838
|
+
--database=<value> Run on specified database. Default is saltcorn_test
|
|
839
|
+
--watch Watch files for changes and rerun tests related to changed files.
|
|
840
|
+
--watchAll Watch files for changes and rerun all tests.
|
|
841
|
+
|
|
842
|
+
DESCRIPTION
|
|
843
|
+
Run test suites
|
|
775
844
|
```
|
|
776
845
|
|
|
777
|
-
_See code: [src/commands/run-tests.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
846
|
+
_See code: [src/commands/run-tests.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/run-tests.js)_
|
|
778
847
|
|
|
779
848
|
## `saltcorn run-trigger TRIGGER`
|
|
780
849
|
|
|
@@ -782,16 +851,19 @@ Run a trigger
|
|
|
782
851
|
|
|
783
852
|
```
|
|
784
853
|
USAGE
|
|
785
|
-
$ saltcorn run-trigger TRIGGER
|
|
854
|
+
$ saltcorn run-trigger TRIGGER [-t <value>]
|
|
786
855
|
|
|
787
856
|
ARGUMENTS
|
|
788
857
|
TRIGGER trigger name
|
|
789
858
|
|
|
790
|
-
|
|
791
|
-
-t, --tenant
|
|
859
|
+
FLAGS
|
|
860
|
+
-t, --tenant=<value> tenant
|
|
861
|
+
|
|
862
|
+
DESCRIPTION
|
|
863
|
+
Run a trigger
|
|
792
864
|
```
|
|
793
865
|
|
|
794
|
-
_See code: [src/commands/run-trigger.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
866
|
+
_See code: [src/commands/run-trigger.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/run-trigger.js)_
|
|
795
867
|
|
|
796
868
|
## `saltcorn scheduler`
|
|
797
869
|
|
|
@@ -799,13 +871,16 @@ Run the Saltcorn scheduler
|
|
|
799
871
|
|
|
800
872
|
```
|
|
801
873
|
USAGE
|
|
802
|
-
$ saltcorn scheduler
|
|
874
|
+
$ saltcorn scheduler [-v]
|
|
803
875
|
|
|
804
|
-
|
|
876
|
+
FLAGS
|
|
805
877
|
-v, --verbose Verbose
|
|
878
|
+
|
|
879
|
+
DESCRIPTION
|
|
880
|
+
Run the Saltcorn scheduler
|
|
806
881
|
```
|
|
807
882
|
|
|
808
|
-
_See code: [src/commands/scheduler.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
883
|
+
_See code: [src/commands/scheduler.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/scheduler.js)_
|
|
809
884
|
|
|
810
885
|
## `saltcorn serve`
|
|
811
886
|
|
|
@@ -813,20 +888,23 @@ Start the Saltcorn server
|
|
|
813
888
|
|
|
814
889
|
```
|
|
815
890
|
USAGE
|
|
816
|
-
$ saltcorn serve
|
|
891
|
+
$ saltcorn serve [-p <value>] [-v] [-r] [-d] [-a] [-n] [-s] [--subdomain_offset <value>]
|
|
892
|
+
|
|
893
|
+
FLAGS
|
|
894
|
+
-a, --addschema Add schema if missing
|
|
895
|
+
-d, --dev Run in dev mode and re-start on file changes
|
|
896
|
+
-n, --nomigrate No migrations
|
|
897
|
+
-p, --port=<value> [default: 3000] port
|
|
898
|
+
-r, --watchReaper Watch reaper
|
|
899
|
+
-s, --noscheduler No scheduler
|
|
900
|
+
-v, --verbose Verbose
|
|
901
|
+
--subdomain_offset=<value> Number of parts to remove to access subdomain in 'multi_tenant' mode
|
|
817
902
|
|
|
818
|
-
|
|
819
|
-
|
|
820
|
-
-d, --dev Run in dev mode and re-start on file changes
|
|
821
|
-
-n, --nomigrate No migrations
|
|
822
|
-
-p, --port=port [default: 3000] port
|
|
823
|
-
-r, --watchReaper Watch reaper
|
|
824
|
-
-s, --noscheduler No scheduler
|
|
825
|
-
-v, --verbose Verbose
|
|
826
|
-
--subdomain_offset=subdomain_offset Number of parts to remove to access subdomain in 'multi_tenant' mode
|
|
903
|
+
DESCRIPTION
|
|
904
|
+
Start the Saltcorn server
|
|
827
905
|
```
|
|
828
906
|
|
|
829
|
-
_See code: [src/commands/serve.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
907
|
+
_See code: [src/commands/serve.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/serve.js)_
|
|
830
908
|
|
|
831
909
|
## `saltcorn set-cfg [KEY] [VALUE]`
|
|
832
910
|
|
|
@@ -834,20 +912,24 @@ Set a configuration value. The supplied value (argument, or file stdin) will be
|
|
|
834
912
|
|
|
835
913
|
```
|
|
836
914
|
USAGE
|
|
837
|
-
$ saltcorn set-cfg [KEY] [VALUE]
|
|
915
|
+
$ saltcorn set-cfg [KEY] [VALUE] [-t <value>] [-p <value>] [-f <value>] [-i]
|
|
838
916
|
|
|
839
917
|
ARGUMENTS
|
|
840
918
|
KEY Configuration key
|
|
841
919
|
VALUE Configuration value (JSON or string)
|
|
842
920
|
|
|
843
|
-
|
|
844
|
-
-f, --file
|
|
845
|
-
-i, --stdin
|
|
846
|
-
-p, --plugin
|
|
847
|
-
-t, --tenant
|
|
921
|
+
FLAGS
|
|
922
|
+
-f, --file=<value> file
|
|
923
|
+
-i, --stdin read value from stdin
|
|
924
|
+
-p, --plugin=<value> plugin
|
|
925
|
+
-t, --tenant=<value> tenant
|
|
926
|
+
|
|
927
|
+
DESCRIPTION
|
|
928
|
+
Set a configuration value. The supplied value (argument, or file stdin) will be parsed as JSON. If this fails, it is
|
|
929
|
+
stored as a string.
|
|
848
930
|
```
|
|
849
931
|
|
|
850
|
-
_See code: [src/commands/set-cfg.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
932
|
+
_See code: [src/commands/set-cfg.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/set-cfg.js)_
|
|
851
933
|
|
|
852
934
|
## `saltcorn set-daily-time [MINS]`
|
|
853
935
|
|
|
@@ -855,16 +937,19 @@ Set the time the default daily event will run, offset in minutes from the curren
|
|
|
855
937
|
|
|
856
938
|
```
|
|
857
939
|
USAGE
|
|
858
|
-
$ saltcorn set-daily-time [MINS]
|
|
940
|
+
$ saltcorn set-daily-time [MINS] [-t <value>]
|
|
859
941
|
|
|
860
942
|
ARGUMENTS
|
|
861
943
|
MINS Number of minutes in the futute (negative for past)
|
|
862
944
|
|
|
863
|
-
|
|
864
|
-
-t, --tenant
|
|
945
|
+
FLAGS
|
|
946
|
+
-t, --tenant=<value> tenant
|
|
947
|
+
|
|
948
|
+
DESCRIPTION
|
|
949
|
+
Set the time the default daily event will run, offset in minutes from the current time. Restart required.
|
|
865
950
|
```
|
|
866
951
|
|
|
867
|
-
_See code: [src/commands/set-daily-time.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
952
|
+
_See code: [src/commands/set-daily-time.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/set-daily-time.js)_
|
|
868
953
|
|
|
869
954
|
## `saltcorn setup`
|
|
870
955
|
|
|
@@ -872,18 +957,19 @@ Set up a new system
|
|
|
872
957
|
|
|
873
958
|
```
|
|
874
959
|
USAGE
|
|
875
|
-
$ saltcorn setup
|
|
960
|
+
$ saltcorn setup [-c]
|
|
876
961
|
|
|
877
|
-
|
|
962
|
+
FLAGS
|
|
878
963
|
-c, --coverage Coverage
|
|
879
964
|
|
|
880
965
|
DESCRIPTION
|
|
966
|
+
Set up a new system
|
|
881
967
|
...
|
|
882
968
|
This will attempt to install or connect a database, and set up a
|
|
883
969
|
configuration file
|
|
884
970
|
```
|
|
885
971
|
|
|
886
|
-
_See code: [src/commands/setup.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
972
|
+
_See code: [src/commands/setup.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/setup.js)_
|
|
887
973
|
|
|
888
974
|
## `saltcorn setup-benchmark`
|
|
889
975
|
|
|
@@ -891,13 +977,17 @@ Setup an instance for benchmarking
|
|
|
891
977
|
|
|
892
978
|
```
|
|
893
979
|
USAGE
|
|
894
|
-
$ saltcorn setup-benchmark
|
|
980
|
+
$ saltcorn setup-benchmark [-t <value>] [-n <value>]
|
|
981
|
+
|
|
982
|
+
FLAGS
|
|
983
|
+
-n, --name=<value> name
|
|
984
|
+
-t, --tenant=<value> tenant
|
|
895
985
|
|
|
896
|
-
|
|
897
|
-
|
|
986
|
+
DESCRIPTION
|
|
987
|
+
Setup an instance for benchmarking
|
|
898
988
|
```
|
|
899
989
|
|
|
900
|
-
_See code: [src/commands/setup-benchmark.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
990
|
+
_See code: [src/commands/setup-benchmark.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/setup-benchmark.js)_
|
|
901
991
|
|
|
902
992
|
## `saltcorn sync-upload-data`
|
|
903
993
|
|
|
@@ -905,16 +995,20 @@ Runs a sync for data supplied by the mobile app
|
|
|
905
995
|
|
|
906
996
|
```
|
|
907
997
|
USAGE
|
|
908
|
-
$ saltcorn sync-upload-data
|
|
998
|
+
$ saltcorn sync-upload-data [--tenantAppName <value>] [--userEmail <value>] [--directory <value>] [--syncTimestamp
|
|
999
|
+
<value>]
|
|
1000
|
+
|
|
1001
|
+
FLAGS
|
|
1002
|
+
--directory=<value> directory name for input output data
|
|
1003
|
+
--syncTimestamp=<value> new timestamp for the sync_info rows
|
|
1004
|
+
--tenantAppName=<value> Optional name of a tenant application
|
|
1005
|
+
--userEmail=<value> email of the user running the sync
|
|
909
1006
|
|
|
910
|
-
|
|
911
|
-
|
|
912
|
-
--syncTimestamp=syncTimestamp new timestamp for the sync_info rows
|
|
913
|
-
--tenantAppName=tenantAppName Optional name of a tenant application
|
|
914
|
-
--userEmail=userEmail email of the user running the sync
|
|
1007
|
+
DESCRIPTION
|
|
1008
|
+
Runs a sync for data supplied by the mobile app
|
|
915
1009
|
```
|
|
916
1010
|
|
|
917
|
-
_See code: [src/commands/sync-upload-data.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
1011
|
+
_See code: [src/commands/sync-upload-data.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/sync-upload-data.js)_
|
|
918
1012
|
|
|
919
1013
|
## `saltcorn take-snapshot`
|
|
920
1014
|
|
|
@@ -922,14 +1016,17 @@ Print a current snapshout to stdout
|
|
|
922
1016
|
|
|
923
1017
|
```
|
|
924
1018
|
USAGE
|
|
925
|
-
$ saltcorn take-snapshot
|
|
1019
|
+
$ saltcorn take-snapshot [-t <value>] [-f]
|
|
1020
|
+
|
|
1021
|
+
FLAGS
|
|
1022
|
+
-f, --fresh fresh
|
|
1023
|
+
-t, --tenant=<value> tenant
|
|
926
1024
|
|
|
927
|
-
|
|
928
|
-
|
|
929
|
-
-t, --tenant=tenant tenant
|
|
1025
|
+
DESCRIPTION
|
|
1026
|
+
Print a current snapshout to stdout
|
|
930
1027
|
```
|
|
931
1028
|
|
|
932
|
-
_See code: [src/commands/take-snapshot.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
1029
|
+
_See code: [src/commands/take-snapshot.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/take-snapshot.js)_
|
|
933
1030
|
|
|
934
1031
|
## `saltcorn transform-field EXPRESSION FIELD TABLE [TENANT]`
|
|
935
1032
|
|
|
@@ -944,7 +1041,10 @@ ARGUMENTS
|
|
|
944
1041
|
FIELD field name
|
|
945
1042
|
TABLE table name
|
|
946
1043
|
TENANT tenant name
|
|
1044
|
+
|
|
1045
|
+
DESCRIPTION
|
|
1046
|
+
transform an existing field by applying a calculated expression
|
|
947
1047
|
```
|
|
948
1048
|
|
|
949
|
-
_See code: [src/commands/transform-field.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.
|
|
1049
|
+
_See code: [src/commands/transform-field.js](https://github.com/saltcorn/saltcorn/blob/v1.0.0-beta.5/packages/saltcorn-cli/src/commands/transform-field.js)_
|
|
950
1050
|
<!-- commandsstop -->
|