kourou 1.4.0-dev.4 → 1.5.0-dev.1
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 +892 -707
- package/bin/run +10 -24
- package/lib/commands/api-key/check.d.ts +11 -14
- package/lib/commands/api-key/check.js +5 -5
- package/lib/commands/api-key/create.d.ts +14 -17
- package/lib/commands/api-key/create.js +7 -5
- package/lib/commands/api-key/delete.d.ts +12 -14
- package/lib/commands/api-key/delete.js +6 -6
- package/lib/commands/api-key/search.d.ts +12 -15
- package/lib/commands/api-key/search.js +5 -3
- package/lib/commands/app/debug-proxy.d.ts +15 -16
- package/lib/commands/app/debug-proxy.js +7 -7
- package/lib/commands/app/doctor.d.ts +11 -12
- package/lib/commands/app/doctor.js +3 -3
- package/lib/commands/app/scaffold.d.ts +5 -8
- package/lib/commands/app/scaffold.js +8 -9
- package/lib/commands/app/start-services.d.ts +2 -2
- package/lib/commands/app/start-services.js +3 -3
- package/lib/commands/collection/create.d.ts +14 -19
- package/lib/commands/collection/create.js +8 -9
- package/lib/commands/collection/export.d.ts +20 -22
- package/lib/commands/collection/export.js +14 -14
- package/lib/commands/collection/import.d.ts +15 -18
- package/lib/commands/collection/import.js +9 -9
- package/lib/commands/collection/migrate.d.ts +15 -17
- package/lib/commands/collection/migrate.js +12 -9
- package/lib/commands/config/diff.d.ts +5 -6
- package/lib/commands/config/diff.js +11 -9
- package/lib/commands/document/search.d.ts +20 -25
- package/lib/commands/document/search.js +13 -13
- package/lib/commands/es/aliases/cat.d.ts +3 -4
- package/lib/commands/es/aliases/cat.js +4 -4
- package/lib/commands/es/indices/cat.d.ts +3 -4
- package/lib/commands/es/indices/cat.js +4 -4
- package/lib/commands/es/indices/get.d.ts +5 -7
- package/lib/commands/es/indices/get.js +7 -7
- package/lib/commands/es/indices/insert.d.ts +6 -9
- package/lib/commands/es/indices/insert.js +8 -8
- package/lib/commands/es/migrate.d.ts +11 -12
- package/lib/commands/es/migrate.js +26 -15
- package/lib/commands/es/snapshot/create-repository.d.ts +6 -8
- package/lib/commands/es/snapshot/create-repository.js +12 -10
- package/lib/commands/es/snapshot/create.d.ts +6 -8
- package/lib/commands/es/snapshot/create.js +11 -8
- package/lib/commands/es/snapshot/list.d.ts +4 -7
- package/lib/commands/es/snapshot/list.js +7 -8
- package/lib/commands/es/snapshot/restore.d.ts +6 -8
- package/lib/commands/es/snapshot/restore.js +11 -8
- package/lib/commands/file/decrypt.d.ts +5 -8
- package/lib/commands/file/decrypt.js +7 -7
- package/lib/commands/file/encrypt.d.ts +5 -8
- package/lib/commands/file/encrypt.js +7 -5
- package/lib/commands/file/test.d.ts +3 -6
- package/lib/commands/file/test.js +5 -5
- package/lib/commands/import.d.ts +13 -16
- package/lib/commands/import.js +8 -9
- package/lib/commands/index/export.d.ts +17 -20
- package/lib/commands/index/export.js +12 -11
- package/lib/commands/index/import.d.ts +14 -17
- package/lib/commands/index/import.js +11 -8
- package/lib/commands/instance/kill.d.ts +2 -3
- package/lib/commands/instance/kill.js +6 -7
- package/lib/commands/instance/logs.d.ts +2 -3
- package/lib/commands/instance/logs.js +3 -3
- package/lib/commands/instance/spawn.d.ts +3 -4
- package/lib/commands/instance/spawn.js +7 -8
- package/lib/commands/paas/login.d.ts +4 -5
- package/lib/commands/paas/login.js +13 -8
- package/lib/commands/profile/export.d.ts +10 -11
- package/lib/commands/profile/export.js +3 -3
- package/lib/commands/profile/import.d.ts +11 -14
- package/lib/commands/profile/import.js +5 -3
- package/lib/commands/realtime/subscribe.d.ts +19 -24
- package/lib/commands/realtime/subscribe.js +12 -12
- package/lib/commands/redis/list-keys.d.ts +14 -17
- package/lib/commands/redis/list-keys.js +8 -9
- package/lib/commands/role/export.d.ts +10 -11
- package/lib/commands/role/export.js +3 -3
- package/lib/commands/role/import.d.ts +12 -15
- package/lib/commands/role/import.js +6 -4
- package/lib/commands/sdk/execute.d.ts +15 -18
- package/lib/commands/sdk/execute.js +9 -10
- package/lib/commands/sdk/query.d.ts +20 -23
- package/lib/commands/sdk/query.js +14 -15
- package/lib/commands/user/export-mappings.d.ts +10 -11
- package/lib/commands/user/export-mappings.js +3 -3
- package/lib/commands/user/export.d.ts +14 -15
- package/lib/commands/user/export.js +7 -7
- package/lib/commands/user/import-mappings.d.ts +11 -14
- package/lib/commands/user/import-mappings.js +5 -3
- package/lib/commands/user/import.d.ts +11 -14
- package/lib/commands/user/import.js +5 -3
- package/lib/commands/vault/add.d.ts +5 -6
- package/lib/commands/vault/add.js +9 -11
- package/lib/commands/vault/decrypt.d.ts +5 -8
- package/lib/commands/vault/decrypt.js +8 -9
- package/lib/commands/vault/encrypt.d.ts +5 -8
- package/lib/commands/vault/encrypt.js +8 -9
- package/lib/commands/vault/show.d.ts +5 -11
- package/lib/commands/vault/show.js +7 -8
- package/lib/commands/vault/test.d.ts +3 -6
- package/lib/commands/vault/test.js +6 -7
- package/lib/common.d.ts +1 -1
- package/lib/common.js +3 -3
- package/lib/help.d.ts +16 -0
- package/lib/help.js +31 -0
- package/lib/hooks/command_not_found/api-action.d.ts +1 -1
- package/lib/hooks/command_not_found/api-action.js +8 -8
- package/lib/index.d.ts +1 -1
- package/lib/index.js +2 -2
- package/lib/support/dump-collection.js +2 -2
- package/lib/support/kuzzle.d.ts +8 -9
- package/lib/support/kuzzle.js +9 -9
- package/lib/support/progressBar.d.ts +10 -0
- package/lib/support/progressBar.js +15 -0
- package/package.json +13 -12
package/README.md
CHANGED
|
@@ -26,8 +26,8 @@ The CLI that helps you manage your Kuzzle instances.
|
|
|
26
26
|
$ npm install -g kourou
|
|
27
27
|
$ kourou COMMAND
|
|
28
28
|
running command...
|
|
29
|
-
$ kourou (
|
|
30
|
-
kourou/1.
|
|
29
|
+
$ kourou (--version)
|
|
30
|
+
kourou/1.5.0-dev.1 linux-x64 node-v24.20.0
|
|
31
31
|
$ kourou --help [COMMAND]
|
|
32
32
|
USAGE
|
|
33
33
|
$ kourou COMMAND
|
|
@@ -179,6 +179,7 @@ All other arguments and options will be passed as-is to the `sdk:query` method.
|
|
|
179
179
|
* [`kourou vault:encrypt FILE`](#kourou-vaultencrypt-file)
|
|
180
180
|
* [`kourou vault:show SECRETS-FILE [KEY]`](#kourou-vaultshow-secrets-file-key)
|
|
181
181
|
* [`kourou vault:test SECRETS-FILE`](#kourou-vaulttest-secrets-file)
|
|
182
|
+
* [`kourou version`](#kourou-version)
|
|
182
183
|
|
|
183
184
|
## `kourou api-key:check TOKEN`
|
|
184
185
|
|
|
@@ -186,27 +187,31 @@ Checks an API key validity
|
|
|
186
187
|
|
|
187
188
|
```
|
|
188
189
|
USAGE
|
|
189
|
-
$ kourou api-key:check TOKEN
|
|
190
|
+
$ kourou api-key:check TOKEN [--help] [--host <value>] [--port <value>] [--ssl] [--username <value>] [--password
|
|
191
|
+
<value>] [--protocol <value>] [--as <value>] [--api-key <value>]
|
|
190
192
|
|
|
191
193
|
ARGUMENTS
|
|
192
194
|
TOKEN API key token
|
|
193
195
|
|
|
194
|
-
|
|
195
|
-
--api-key
|
|
196
|
-
--as
|
|
197
|
-
--help
|
|
198
|
-
--host
|
|
199
|
-
--password
|
|
200
|
-
--port
|
|
201
|
-
--protocol
|
|
202
|
-
--ssl
|
|
203
|
-
--username
|
|
196
|
+
FLAGS
|
|
197
|
+
--api-key=<value> Kuzzle user api-key
|
|
198
|
+
--as=<value> Impersonate a user
|
|
199
|
+
--help Show CLI help.
|
|
200
|
+
--host=<value> [default: localhost] Kuzzle server host
|
|
201
|
+
--password=<value> Kuzzle user password
|
|
202
|
+
--port=<value> [default: 7512] Kuzzle server port
|
|
203
|
+
--protocol=<value> [default: ws] Kuzzle protocol (http or ws)
|
|
204
|
+
--ssl Use SSL to connect to Kuzzle
|
|
205
|
+
--username=<value> [default: anonymous] Kuzzle username (local strategy)
|
|
204
206
|
|
|
205
|
-
|
|
206
|
-
|
|
207
|
+
DESCRIPTION
|
|
208
|
+
Checks an API key validity
|
|
209
|
+
|
|
210
|
+
EXAMPLES
|
|
211
|
+
$ kourou api-key:check eyJhbG...QxfQrc
|
|
207
212
|
```
|
|
208
213
|
|
|
209
|
-
_See code: [
|
|
214
|
+
_See code: [src/commands/api-key/check.ts](src/commands/api-key/check.ts)_
|
|
210
215
|
|
|
211
216
|
## `kourou api-key:create USER`
|
|
212
217
|
|
|
@@ -214,27 +219,31 @@ Creates a new API Key for a user
|
|
|
214
219
|
|
|
215
220
|
```
|
|
216
221
|
USAGE
|
|
217
|
-
$ kourou api-key:create USER
|
|
222
|
+
$ kourou api-key:create USER -d <value> [--help] [--id <value>] [--expire <value>] [--host <value>] [--port
|
|
223
|
+
<value>] [--ssl] [--username <value>] [--password <value>] [--protocol <value>] [--as <value>] [--api-key <value>]
|
|
218
224
|
|
|
219
225
|
ARGUMENTS
|
|
220
226
|
USER User kuid
|
|
221
227
|
|
|
222
|
-
|
|
223
|
-
-d, --description
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
228
|
+
FLAGS
|
|
229
|
+
-d, --description=<value> (required) API Key description
|
|
230
|
+
--api-key=<value> Kuzzle user api-key
|
|
231
|
+
--as=<value> Impersonate a user
|
|
232
|
+
--expire=<value> [default: -1] API Key validity
|
|
233
|
+
--help Show CLI help.
|
|
234
|
+
--host=<value> [default: localhost] Kuzzle server host
|
|
235
|
+
--id=<value> API Key unique ID
|
|
236
|
+
--password=<value> Kuzzle user password
|
|
237
|
+
--port=<value> [default: 7512] Kuzzle server port
|
|
238
|
+
--protocol=<value> [default: ws] Kuzzle protocol (http or ws)
|
|
239
|
+
--ssl Use SSL to connect to Kuzzle
|
|
240
|
+
--username=<value> [default: anonymous] Kuzzle username (local strategy)
|
|
241
|
+
|
|
242
|
+
DESCRIPTION
|
|
243
|
+
Creates a new API Key for a user
|
|
235
244
|
```
|
|
236
245
|
|
|
237
|
-
_See code: [
|
|
246
|
+
_See code: [src/commands/api-key/create.ts](src/commands/api-key/create.ts)_
|
|
238
247
|
|
|
239
248
|
## `kourou api-key:delete USER ID`
|
|
240
249
|
|
|
@@ -242,28 +251,32 @@ Deletes an API key.
|
|
|
242
251
|
|
|
243
252
|
```
|
|
244
253
|
USAGE
|
|
245
|
-
$ kourou api-key:delete USER ID
|
|
254
|
+
$ kourou api-key:delete USER ID [--help] [--host <value>] [--port <value>] [--ssl] [--username <value>]
|
|
255
|
+
[--password <value>] [--protocol <value>] [--as <value>] [--api-key <value>]
|
|
246
256
|
|
|
247
257
|
ARGUMENTS
|
|
248
258
|
USER User kuid
|
|
249
259
|
ID API Key unique ID
|
|
250
260
|
|
|
251
|
-
|
|
252
|
-
--api-key
|
|
253
|
-
--as
|
|
254
|
-
--help
|
|
255
|
-
--host
|
|
256
|
-
--password
|
|
257
|
-
--port
|
|
258
|
-
--protocol
|
|
259
|
-
--ssl
|
|
260
|
-
--username
|
|
261
|
+
FLAGS
|
|
262
|
+
--api-key=<value> Kuzzle user api-key
|
|
263
|
+
--as=<value> Impersonate a user
|
|
264
|
+
--help Show CLI help.
|
|
265
|
+
--host=<value> [default: localhost] Kuzzle server host
|
|
266
|
+
--password=<value> Kuzzle user password
|
|
267
|
+
--port=<value> [default: 7512] Kuzzle server port
|
|
268
|
+
--protocol=<value> [default: ws] Kuzzle protocol (http or ws)
|
|
269
|
+
--ssl Use SSL to connect to Kuzzle
|
|
270
|
+
--username=<value> [default: anonymous] Kuzzle username (local strategy)
|
|
271
|
+
|
|
272
|
+
DESCRIPTION
|
|
273
|
+
Deletes an API key.
|
|
261
274
|
|
|
262
|
-
|
|
263
|
-
kourou vault:delete sigfox-gateway 1k-BF3EBjsXdvA2PR8x
|
|
275
|
+
EXAMPLES
|
|
276
|
+
$ kourou vault:delete sigfox-gateway 1k-BF3EBjsXdvA2PR8x
|
|
264
277
|
```
|
|
265
278
|
|
|
266
|
-
_See code: [
|
|
279
|
+
_See code: [src/commands/api-key/delete.ts](src/commands/api-key/delete.ts)_
|
|
267
280
|
|
|
268
281
|
## `kourou api-key:search USER`
|
|
269
282
|
|
|
@@ -271,25 +284,29 @@ Lists a user's API Keys.
|
|
|
271
284
|
|
|
272
285
|
```
|
|
273
286
|
USAGE
|
|
274
|
-
$ kourou api-key:search USER
|
|
287
|
+
$ kourou api-key:search USER [--help] [--filter <value>] [--host <value>] [--port <value>] [--ssl] [--username
|
|
288
|
+
<value>] [--password <value>] [--protocol <value>] [--as <value>] [--api-key <value>]
|
|
275
289
|
|
|
276
290
|
ARGUMENTS
|
|
277
291
|
USER User kuid
|
|
278
292
|
|
|
279
|
-
|
|
280
|
-
--api-key
|
|
281
|
-
--as
|
|
282
|
-
--filter
|
|
283
|
-
--help
|
|
284
|
-
--host
|
|
285
|
-
--password
|
|
286
|
-
--port
|
|
287
|
-
--protocol
|
|
288
|
-
--ssl
|
|
289
|
-
--username
|
|
293
|
+
FLAGS
|
|
294
|
+
--api-key=<value> Kuzzle user api-key
|
|
295
|
+
--as=<value> Impersonate a user
|
|
296
|
+
--filter=<value> Filter to match the API Key descriptions
|
|
297
|
+
--help Show CLI help.
|
|
298
|
+
--host=<value> [default: localhost] Kuzzle server host
|
|
299
|
+
--password=<value> Kuzzle user password
|
|
300
|
+
--port=<value> [default: 7512] Kuzzle server port
|
|
301
|
+
--protocol=<value> [default: ws] Kuzzle protocol (http or ws)
|
|
302
|
+
--ssl Use SSL to connect to Kuzzle
|
|
303
|
+
--username=<value> [default: anonymous] Kuzzle username (local strategy)
|
|
304
|
+
|
|
305
|
+
DESCRIPTION
|
|
306
|
+
Lists a user's API Keys.
|
|
290
307
|
```
|
|
291
308
|
|
|
292
|
-
_See code: [
|
|
309
|
+
_See code: [src/commands/api-key/search.ts](src/commands/api-key/search.ts)_
|
|
293
310
|
|
|
294
311
|
## `kourou app:debug-proxy`
|
|
295
312
|
|
|
@@ -297,37 +314,32 @@ Create a Proxy Server that allows Chrome to debug Kuzzle remotely using the Debu
|
|
|
297
314
|
|
|
298
315
|
```
|
|
299
316
|
USAGE
|
|
300
|
-
$ kourou app:debug-proxy
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
--
|
|
306
|
-
--
|
|
307
|
-
--
|
|
308
|
-
--
|
|
309
|
-
|
|
310
|
-
--
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
--
|
|
314
|
-
|
|
315
|
-
--
|
|
316
|
-
|
|
317
|
-
--
|
|
317
|
+
$ kourou app:debug-proxy [--help] [--forwardPort <value>] [--ttl <value>] [--keepAuth] [--noAutoEnableDebugger]
|
|
318
|
+
[--showDebuggerEvents] [--showDebuggerPayloads] [--host <value>] [--port <value>] [--ssl] [--username <value>]
|
|
319
|
+
[--password <value>] [--protocol <value>] [--as <value>] [--api-key <value>]
|
|
320
|
+
|
|
321
|
+
FLAGS
|
|
322
|
+
--api-key=<value> Kuzzle user api-key
|
|
323
|
+
--as=<value> Impersonate a user
|
|
324
|
+
--forwardPort=<value> [default: 9222] Port of the forwarding server
|
|
325
|
+
--help Show CLI help.
|
|
326
|
+
--host=<value> [default: localhost] Kuzzle server host
|
|
327
|
+
--keepAuth Keep the user authenticated
|
|
328
|
+
--noAutoEnableDebugger True if Kourou should not enable and disable the Debugger automatically before and after usage
|
|
329
|
+
--password=<value> Kuzzle user password
|
|
330
|
+
--port=<value> [default: 7512] Kuzzle server port
|
|
331
|
+
--protocol=<value> [default: ws] Kuzzle protocol (http or ws)
|
|
332
|
+
--showDebuggerEvents Verbose mode to display events sent to the Chrome Debugger
|
|
333
|
+
--showDebuggerPayloads Verbose mode to display payloads sent by and to the Chrome Debugger
|
|
334
|
+
--ssl Use SSL to connect to Kuzzle
|
|
335
|
+
--ttl=<value> [default: 1h] Kuzzle login TTL
|
|
336
|
+
--username=<value> [default: anonymous] Kuzzle username (local strategy)
|
|
318
337
|
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
--showDebuggerPayloads Verbose mode to display payloads sent by and to the Chrome Debugger
|
|
322
|
-
|
|
323
|
-
--ssl Use SSL to connect to Kuzzle
|
|
324
|
-
|
|
325
|
-
--ttl=ttl [default: 1h] Kuzzle login TTL
|
|
326
|
-
|
|
327
|
-
--username=username [default: anonymous] Kuzzle username (local strategy)
|
|
338
|
+
DESCRIPTION
|
|
339
|
+
Create a Proxy Server that allows Chrome to debug Kuzzle remotely using the DebugController
|
|
328
340
|
```
|
|
329
341
|
|
|
330
|
-
_See code: [
|
|
342
|
+
_See code: [src/commands/app/debug-proxy.ts](src/commands/app/debug-proxy.ts)_
|
|
331
343
|
|
|
332
344
|
## `kourou app:doctor`
|
|
333
345
|
|
|
@@ -335,22 +347,26 @@ Analyze a Kuzzle application
|
|
|
335
347
|
|
|
336
348
|
```
|
|
337
349
|
USAGE
|
|
338
|
-
$ kourou app:doctor
|
|
350
|
+
$ kourou app:doctor [--help] [--elasticsearch <value>] [--host <value>] [--port <value>] [--ssl] [--username
|
|
351
|
+
<value>] [--password <value>] [--protocol <value>] [--as <value>] [--api-key <value>]
|
|
352
|
+
|
|
353
|
+
FLAGS
|
|
354
|
+
--api-key=<value> Kuzzle user api-key
|
|
355
|
+
--as=<value> Impersonate a user
|
|
356
|
+
--elasticsearch=<value> [default: http://localhost:9200] Elasticsearch server URL
|
|
357
|
+
--help Show CLI help.
|
|
358
|
+
--host=<value> [default: localhost] Kuzzle server host
|
|
359
|
+
--password=<value> Kuzzle user password
|
|
360
|
+
--port=<value> [default: 7512] Kuzzle server port
|
|
361
|
+
--protocol=<value> [default: ws] Kuzzle protocol (http or ws)
|
|
362
|
+
--ssl Use SSL to connect to Kuzzle
|
|
363
|
+
--username=<value> [default: anonymous] Kuzzle username (local strategy)
|
|
339
364
|
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
--as=as Impersonate a user
|
|
343
|
-
--elasticsearch=elasticsearch [default: http://localhost:9200] Elasticsearch server URL
|
|
344
|
-
--help show CLI help
|
|
345
|
-
--host=host [default: localhost] Kuzzle server host
|
|
346
|
-
--password=password Kuzzle user password
|
|
347
|
-
--port=port [default: 7512] Kuzzle server port
|
|
348
|
-
--protocol=protocol [default: ws] Kuzzle protocol (http or ws)
|
|
349
|
-
--ssl Use SSL to connect to Kuzzle
|
|
350
|
-
--username=username [default: anonymous] Kuzzle username (local strategy)
|
|
365
|
+
DESCRIPTION
|
|
366
|
+
Analyze a Kuzzle application
|
|
351
367
|
```
|
|
352
368
|
|
|
353
|
-
_See code: [
|
|
369
|
+
_See code: [src/commands/app/doctor.ts](src/commands/app/doctor.ts)_
|
|
354
370
|
|
|
355
371
|
## `kourou app:scaffold DESTINATION`
|
|
356
372
|
|
|
@@ -358,20 +374,22 @@ Scaffolds a new Kuzzle application
|
|
|
358
374
|
|
|
359
375
|
```
|
|
360
376
|
USAGE
|
|
361
|
-
$ kourou app:scaffold DESTINATION
|
|
377
|
+
$ kourou app:scaffold DESTINATION [--help] [--flavor <value>] [--token <value>]
|
|
362
378
|
|
|
363
379
|
ARGUMENTS
|
|
364
380
|
DESTINATION Directory to scaffold the app
|
|
365
381
|
|
|
366
|
-
|
|
367
|
-
--flavor
|
|
368
|
-
--help
|
|
382
|
+
FLAGS
|
|
383
|
+
--flavor=<value> [default: generic] Template flavor ("generic", "iot", "hypervision").
|
|
384
|
+
--help Show CLI help.
|
|
385
|
+
--token=<value> GitHub token used to clone private template repositories.
|
|
386
|
+
Defaults to the GITHUB_TOKEN environment variable, then to the GitHub CLI credentials.
|
|
369
387
|
|
|
370
|
-
|
|
371
|
-
|
|
388
|
+
DESCRIPTION
|
|
389
|
+
Scaffolds a new Kuzzle application
|
|
372
390
|
```
|
|
373
391
|
|
|
374
|
-
_See code: [
|
|
392
|
+
_See code: [src/commands/app/scaffold.ts](src/commands/app/scaffold.ts)_
|
|
375
393
|
|
|
376
394
|
## `kourou app:start-services`
|
|
377
395
|
|
|
@@ -379,37 +397,48 @@ Starts Kuzzle services (Elasticsearch and Redis)
|
|
|
379
397
|
|
|
380
398
|
```
|
|
381
399
|
USAGE
|
|
382
|
-
$ kourou app:start-services
|
|
400
|
+
$ kourou app:start-services [--help] [--check]
|
|
383
401
|
|
|
384
|
-
|
|
402
|
+
FLAGS
|
|
385
403
|
--check Check prerequisite before running services
|
|
386
|
-
--help
|
|
404
|
+
--help Show CLI help.
|
|
405
|
+
|
|
406
|
+
DESCRIPTION
|
|
407
|
+
Starts Kuzzle services (Elasticsearch and Redis)
|
|
387
408
|
```
|
|
388
409
|
|
|
389
|
-
_See code: [
|
|
410
|
+
_See code: [src/commands/app/start-services.ts](src/commands/app/start-services.ts)_
|
|
390
411
|
|
|
391
412
|
## `kourou autocomplete [SHELL]`
|
|
392
413
|
|
|
393
|
-
|
|
414
|
+
Display autocomplete installation instructions.
|
|
394
415
|
|
|
395
416
|
```
|
|
396
417
|
USAGE
|
|
397
|
-
$ kourou autocomplete [SHELL]
|
|
418
|
+
$ kourou autocomplete [SHELL] [-r]
|
|
398
419
|
|
|
399
420
|
ARGUMENTS
|
|
400
|
-
SHELL
|
|
421
|
+
[SHELL] (zsh|bash|powershell) Shell type
|
|
401
422
|
|
|
402
|
-
|
|
423
|
+
FLAGS
|
|
403
424
|
-r, --refresh-cache Refresh cache (ignores displaying instructions)
|
|
404
425
|
|
|
426
|
+
DESCRIPTION
|
|
427
|
+
Display autocomplete installation instructions.
|
|
428
|
+
|
|
405
429
|
EXAMPLES
|
|
406
430
|
$ kourou autocomplete
|
|
431
|
+
|
|
407
432
|
$ kourou autocomplete bash
|
|
433
|
+
|
|
408
434
|
$ kourou autocomplete zsh
|
|
435
|
+
|
|
436
|
+
$ kourou autocomplete powershell
|
|
437
|
+
|
|
409
438
|
$ kourou autocomplete --refresh-cache
|
|
410
439
|
```
|
|
411
440
|
|
|
412
|
-
_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/
|
|
441
|
+
_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v4.0.0/src/commands/autocomplete/index.ts)_
|
|
413
442
|
|
|
414
443
|
## `kourou collection:create INDEX COLLECTION [BODY]`
|
|
415
444
|
|
|
@@ -417,26 +446,30 @@ Creates a collection
|
|
|
417
446
|
|
|
418
447
|
```
|
|
419
448
|
USAGE
|
|
420
|
-
$ kourou collection:create INDEX COLLECTION [BODY]
|
|
449
|
+
$ kourou collection:create INDEX COLLECTION [BODY] [--help] [--host <value>] [--port <value>] [--ssl] [--username
|
|
450
|
+
<value>] [--password <value>] [--protocol <value>] [--as <value>] [--api-key <value>]
|
|
421
451
|
|
|
422
452
|
ARGUMENTS
|
|
423
453
|
INDEX Index name
|
|
424
454
|
COLLECTION Collection name
|
|
425
|
-
BODY
|
|
455
|
+
[BODY] Collection mappings and settings in JS or JSON format. Will be read from STDIN if available
|
|
456
|
+
|
|
457
|
+
FLAGS
|
|
458
|
+
--api-key=<value> Kuzzle user api-key
|
|
459
|
+
--as=<value> Impersonate a user
|
|
460
|
+
--help Show CLI help.
|
|
461
|
+
--host=<value> [default: localhost] Kuzzle server host
|
|
462
|
+
--password=<value> Kuzzle user password
|
|
463
|
+
--port=<value> [default: 7512] Kuzzle server port
|
|
464
|
+
--protocol=<value> [default: ws] Kuzzle protocol (http or ws)
|
|
465
|
+
--ssl Use SSL to connect to Kuzzle
|
|
466
|
+
--username=<value> [default: anonymous] Kuzzle username (local strategy)
|
|
426
467
|
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
--as=as Impersonate a user
|
|
430
|
-
--help show CLI help
|
|
431
|
-
--host=host [default: localhost] Kuzzle server host
|
|
432
|
-
--password=password Kuzzle user password
|
|
433
|
-
--port=port [default: 7512] Kuzzle server port
|
|
434
|
-
--protocol=protocol [default: ws] Kuzzle protocol (http or ws)
|
|
435
|
-
--ssl Use SSL to connect to Kuzzle
|
|
436
|
-
--username=username [default: anonymous] Kuzzle username (local strategy)
|
|
468
|
+
DESCRIPTION
|
|
469
|
+
Creates a collection
|
|
437
470
|
```
|
|
438
471
|
|
|
439
|
-
_See code: [
|
|
472
|
+
_See code: [src/commands/collection/create.ts](src/commands/collection/create.ts)_
|
|
440
473
|
|
|
441
474
|
## `kourou collection:export INDEX COLLECTION`
|
|
442
475
|
|
|
@@ -444,26 +477,29 @@ Exports a collection (JSONL format)
|
|
|
444
477
|
|
|
445
478
|
```
|
|
446
479
|
USAGE
|
|
447
|
-
$ kourou collection:export INDEX COLLECTION
|
|
480
|
+
$ kourou collection:export INDEX COLLECTION [--help] [--path <value>] [--batch-size <value>] [--query <value>]
|
|
481
|
+
[--editor] [--format jsonl|kuzzle|csv] [--fields <value>] [--scrollTTL <value>] [--type <value>] [--host <value>]
|
|
482
|
+
[--port <value>] [--ssl] [--username <value>] [--password <value>] [--protocol <value>] [--as <value>] [--api-key
|
|
483
|
+
<value>]
|
|
448
484
|
|
|
449
485
|
ARGUMENTS
|
|
450
486
|
INDEX Index name
|
|
451
487
|
COLLECTION Collection name
|
|
452
488
|
|
|
453
|
-
|
|
454
|
-
--api-key
|
|
489
|
+
FLAGS
|
|
490
|
+
--api-key=<value>
|
|
455
491
|
Kuzzle user api-key
|
|
456
492
|
|
|
457
|
-
--as
|
|
493
|
+
--as=<value>
|
|
458
494
|
Impersonate a user
|
|
459
495
|
|
|
460
|
-
--batch-size
|
|
496
|
+
--batch-size=<value>
|
|
461
497
|
[default: 2000] Maximum batch size (see limits.documentsFetchCount config)
|
|
462
498
|
|
|
463
499
|
--editor
|
|
464
500
|
Open an editor (EDITOR env variable) to edit the query before sending
|
|
465
501
|
|
|
466
|
-
--fields
|
|
502
|
+
--fields=<value>
|
|
467
503
|
[CSV format only] The list of fields to be included in the CSV export in dot-path format.
|
|
468
504
|
|
|
469
505
|
Example:
|
|
@@ -472,33 +508,34 @@ OPTIONS
|
|
|
472
508
|
Note that the '_id' field is always included in the CSV export. Leaving this option empty implies that all
|
|
473
509
|
exportable fields in the mapping will be exported.
|
|
474
510
|
|
|
475
|
-
--format
|
|
511
|
+
--format=<option>
|
|
476
512
|
[default: jsonl] "kuzzle" will export in Kuzzle format usable for internal fixtures,
|
|
477
513
|
"jsonl" allows to import that data back with kourou,
|
|
478
514
|
"csv" allows to import data into Excel (please, specify the fields to export using the --fields option).
|
|
515
|
+
<options: jsonl|kuzzle|csv>
|
|
479
516
|
|
|
480
517
|
--help
|
|
481
|
-
|
|
518
|
+
Show CLI help.
|
|
482
519
|
|
|
483
|
-
--host
|
|
520
|
+
--host=<value>
|
|
484
521
|
[default: localhost] Kuzzle server host
|
|
485
522
|
|
|
486
|
-
--password
|
|
523
|
+
--password=<value>
|
|
487
524
|
Kuzzle user password
|
|
488
525
|
|
|
489
|
-
--path
|
|
526
|
+
--path=<value>
|
|
490
527
|
Dump root directory
|
|
491
528
|
|
|
492
|
-
--port
|
|
529
|
+
--port=<value>
|
|
493
530
|
[default: 7512] Kuzzle server port
|
|
494
531
|
|
|
495
|
-
--protocol
|
|
532
|
+
--protocol=<value>
|
|
496
533
|
[default: ws] Kuzzle protocol (http or websocket)
|
|
497
534
|
|
|
498
|
-
--query
|
|
535
|
+
--query=<value>
|
|
499
536
|
[default: {}] Only dump documents matching the query (JS or JSON format)
|
|
500
537
|
|
|
501
|
-
--scrollTTL
|
|
538
|
+
--scrollTTL=<value>
|
|
502
539
|
[default: 20s] The scroll TTL option to pass to the dump operation (which performs a document.search under the
|
|
503
540
|
hood),
|
|
504
541
|
expressed in ms format, e.g. '2s', '1m', '3h'.
|
|
@@ -506,18 +543,22 @@ OPTIONS
|
|
|
506
543
|
--ssl
|
|
507
544
|
Use SSL to connect to Kuzzle
|
|
508
545
|
|
|
509
|
-
--type
|
|
546
|
+
--type=<value>
|
|
510
547
|
[default: all] Type of the export: all, mappings, data
|
|
511
548
|
|
|
512
|
-
--username
|
|
549
|
+
--username=<value>
|
|
513
550
|
[default: anonymous] Kuzzle username (local strategy)
|
|
514
551
|
|
|
552
|
+
DESCRIPTION
|
|
553
|
+
Exports a collection (JSONL format)
|
|
554
|
+
|
|
515
555
|
EXAMPLES
|
|
516
|
-
kourou collection:export nyc-open-data yellow-taxi
|
|
517
|
-
|
|
556
|
+
$ kourou collection:export nyc-open-data yellow-taxi
|
|
557
|
+
|
|
558
|
+
$ kourou collection:export nyc-open-data yellow-taxi --query '{ term: { city: "Saigon" } }'
|
|
518
559
|
```
|
|
519
560
|
|
|
520
|
-
_See code: [
|
|
561
|
+
_See code: [src/commands/collection/export.ts](src/commands/collection/export.ts)_
|
|
521
562
|
|
|
522
563
|
## `kourou collection:import PATH`
|
|
523
564
|
|
|
@@ -525,28 +566,33 @@ Imports a collection
|
|
|
525
566
|
|
|
526
567
|
```
|
|
527
568
|
USAGE
|
|
528
|
-
$ kourou collection:import PATH
|
|
569
|
+
$ kourou collection:import PATH [--help] [--batch-size <value>] [--index <value>] [--collection <value>]
|
|
570
|
+
[--no-mappings] [--host <value>] [--port <value>] [--ssl] [--username <value>] [--password <value>] [--protocol
|
|
571
|
+
<value>] [--as <value>] [--api-key <value>]
|
|
529
572
|
|
|
530
573
|
ARGUMENTS
|
|
531
574
|
PATH Dump directory path
|
|
532
575
|
|
|
533
|
-
|
|
534
|
-
--api-key
|
|
535
|
-
--as
|
|
536
|
-
--batch-size
|
|
537
|
-
--collection
|
|
538
|
-
--help
|
|
539
|
-
--host
|
|
540
|
-
--index
|
|
541
|
-
--no-mappings
|
|
542
|
-
--password
|
|
543
|
-
--port
|
|
544
|
-
--protocol
|
|
545
|
-
--ssl
|
|
546
|
-
--username
|
|
576
|
+
FLAGS
|
|
577
|
+
--api-key=<value> Kuzzle user api-key
|
|
578
|
+
--as=<value> Impersonate a user
|
|
579
|
+
--batch-size=<value> [default: 200] Maximum batch size (see limits.documentsWriteCount config)
|
|
580
|
+
--collection=<value> If set, override the collection destination name
|
|
581
|
+
--help Show CLI help.
|
|
582
|
+
--host=<value> [default: localhost] Kuzzle server host
|
|
583
|
+
--index=<value> If set, override the index destination name
|
|
584
|
+
--no-mappings Skip collection mappings
|
|
585
|
+
--password=<value> Kuzzle user password
|
|
586
|
+
--port=<value> [default: 7512] Kuzzle server port
|
|
587
|
+
--protocol=<value> [default: ws] Kuzzle protocol (http or websocket)
|
|
588
|
+
--ssl Use SSL to connect to Kuzzle
|
|
589
|
+
--username=<value> [default: anonymous] Kuzzle username (local strategy)
|
|
590
|
+
|
|
591
|
+
DESCRIPTION
|
|
592
|
+
Imports a collection
|
|
547
593
|
```
|
|
548
594
|
|
|
549
|
-
_See code: [
|
|
595
|
+
_See code: [src/commands/collection/import.ts](src/commands/collection/import.ts)_
|
|
550
596
|
|
|
551
597
|
## `kourou collection:migrate SCRIPT PATH`
|
|
552
598
|
|
|
@@ -554,28 +600,33 @@ Migrate a collection by transforming documents from a dump file and importing th
|
|
|
554
600
|
|
|
555
601
|
```
|
|
556
602
|
USAGE
|
|
557
|
-
$ kourou collection:migrate SCRIPT PATH
|
|
603
|
+
$ kourou collection:migrate SCRIPT PATH [--help] [--batch-size <value>] [--index <value>] [--collection <value>]
|
|
604
|
+
[--host <value>] [--port <value>] [--ssl] [--username <value>] [--password <value>] [--protocol <value>] [--as
|
|
605
|
+
<value>] [--api-key <value>]
|
|
558
606
|
|
|
559
607
|
ARGUMENTS
|
|
560
608
|
SCRIPT Migration script path
|
|
561
609
|
PATH Collection dump path
|
|
562
610
|
|
|
563
|
-
|
|
564
|
-
--api-key
|
|
565
|
-
--as
|
|
566
|
-
--batch-size
|
|
567
|
-
--collection
|
|
568
|
-
--help
|
|
569
|
-
--host
|
|
570
|
-
--index
|
|
571
|
-
--password
|
|
572
|
-
--port
|
|
573
|
-
--protocol
|
|
574
|
-
--ssl
|
|
575
|
-
--username
|
|
611
|
+
FLAGS
|
|
612
|
+
--api-key=<value> Kuzzle user api-key
|
|
613
|
+
--as=<value> Impersonate a user
|
|
614
|
+
--batch-size=<value> [default: 200] Maximum batch size (see limits.documentsWriteCount config)
|
|
615
|
+
--collection=<value> If set, override the collection destination name
|
|
616
|
+
--help Show CLI help.
|
|
617
|
+
--host=<value> [default: localhost] Kuzzle server host
|
|
618
|
+
--index=<value> If set, override the index destination name
|
|
619
|
+
--password=<value> Kuzzle user password
|
|
620
|
+
--port=<value> [default: 7512] Kuzzle server port
|
|
621
|
+
--protocol=<value> [default: ws] Kuzzle protocol (http or websocket)
|
|
622
|
+
--ssl Use SSL to connect to Kuzzle
|
|
623
|
+
--username=<value> [default: anonymous] Kuzzle username (local strategy)
|
|
624
|
+
|
|
625
|
+
DESCRIPTION
|
|
626
|
+
Migrate a collection by transforming documents from a dump file and importing them into Kuzzle
|
|
576
627
|
```
|
|
577
628
|
|
|
578
|
-
_See code: [
|
|
629
|
+
_See code: [src/commands/collection/migrate.ts](src/commands/collection/migrate.ts)_
|
|
579
630
|
|
|
580
631
|
## `kourou config:diff FIRST SECOND`
|
|
581
632
|
|
|
@@ -583,21 +634,24 @@ Returns differences between two Kuzzle configuration files (kuzzlerc)
|
|
|
583
634
|
|
|
584
635
|
```
|
|
585
636
|
USAGE
|
|
586
|
-
$ kourou config:diff FIRST SECOND
|
|
637
|
+
$ kourou config:diff FIRST SECOND [--strict] [--values]
|
|
587
638
|
|
|
588
639
|
ARGUMENTS
|
|
589
640
|
FIRST First configuration file
|
|
590
641
|
SECOND Second configuration file
|
|
591
642
|
|
|
592
|
-
|
|
643
|
+
FLAGS
|
|
593
644
|
--strict Exit with an error if differences are found
|
|
594
645
|
--values Also displays value changes
|
|
595
646
|
|
|
596
|
-
|
|
597
|
-
|
|
647
|
+
DESCRIPTION
|
|
648
|
+
Returns differences between two Kuzzle configuration files (kuzzlerc)
|
|
649
|
+
|
|
650
|
+
EXAMPLES
|
|
651
|
+
$ kourou config:diff config/local/kuzzlerc config/production/kuzzlerc
|
|
598
652
|
```
|
|
599
653
|
|
|
600
|
-
_See code: [
|
|
654
|
+
_See code: [src/commands/config/diff.ts](src/commands/config/diff.ts)_
|
|
601
655
|
|
|
602
656
|
## `kourou document:search INDEX COLLECTION [QUERY]`
|
|
603
657
|
|
|
@@ -605,37 +659,44 @@ Searches for documents
|
|
|
605
659
|
|
|
606
660
|
```
|
|
607
661
|
USAGE
|
|
608
|
-
$ kourou document:search INDEX COLLECTION [QUERY]
|
|
662
|
+
$ kourou document:search INDEX COLLECTION [QUERY] [--sort <value>] [--from <value>] [--size <value>] [--scroll
|
|
663
|
+
<value>] [--lang <value>] [--editor] [--help] [--host <value>] [--port <value>] [--ssl] [--username <value>]
|
|
664
|
+
[--password <value>] [--protocol <value>] [--as <value>] [--api-key <value>]
|
|
609
665
|
|
|
610
666
|
ARGUMENTS
|
|
611
667
|
INDEX Index name
|
|
612
668
|
COLLECTION Collection name
|
|
613
|
-
QUERY
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
--api-key
|
|
617
|
-
--as
|
|
618
|
-
--editor
|
|
619
|
-
--from
|
|
620
|
-
--help
|
|
621
|
-
--host
|
|
622
|
-
--lang
|
|
623
|
-
--password
|
|
624
|
-
--port
|
|
625
|
-
--protocol
|
|
626
|
-
--scroll
|
|
627
|
-
--size
|
|
628
|
-
--sort
|
|
629
|
-
--ssl
|
|
630
|
-
--username
|
|
669
|
+
[QUERY] Search query in JS or JSON format.
|
|
670
|
+
|
|
671
|
+
FLAGS
|
|
672
|
+
--api-key=<value> Kuzzle user api-key
|
|
673
|
+
--as=<value> Impersonate a user
|
|
674
|
+
--editor Open an editor (EDITOR env variable) to edit the request before sending
|
|
675
|
+
--from=<value> Optional offset
|
|
676
|
+
--help Show CLI help.
|
|
677
|
+
--host=<value> [default: localhost] Kuzzle server host
|
|
678
|
+
--lang=<value> [default: koncorde] Specify the query language to use
|
|
679
|
+
--password=<value> Kuzzle user password
|
|
680
|
+
--port=<value> [default: 7512] Kuzzle server port
|
|
681
|
+
--protocol=<value> [default: ws] Kuzzle protocol (http or ws)
|
|
682
|
+
--scroll=<value> Optional scroll TTL
|
|
683
|
+
--size=<value> Optional page size
|
|
684
|
+
--sort=<value> [default: {}] Sort in JS or JSON format.
|
|
685
|
+
--ssl Use SSL to connect to Kuzzle
|
|
686
|
+
--username=<value> [default: anonymous] Kuzzle username (local strategy)
|
|
687
|
+
|
|
688
|
+
DESCRIPTION
|
|
689
|
+
Searches for documents
|
|
631
690
|
|
|
632
691
|
EXAMPLES
|
|
633
|
-
kourou document:search iot sensors '{ equals: { name: "corona" } }'
|
|
634
|
-
|
|
635
|
-
kourou document:search iot sensors
|
|
692
|
+
$ kourou document:search iot sensors '{ equals: { name: "corona" } }'
|
|
693
|
+
|
|
694
|
+
$ kourou document:search iot sensors '{ match: { name: "cOrOnna" } }' -a lang=elasticsearch
|
|
695
|
+
|
|
696
|
+
$ kourou document:search iot sensors --editor
|
|
636
697
|
```
|
|
637
698
|
|
|
638
|
-
_See code: [
|
|
699
|
+
_See code: [src/commands/document/search.ts](src/commands/document/search.ts)_
|
|
639
700
|
|
|
640
701
|
## `kourou es:aliases:cat`
|
|
641
702
|
|
|
@@ -643,15 +704,18 @@ Lists available ES aliases
|
|
|
643
704
|
|
|
644
705
|
```
|
|
645
706
|
USAGE
|
|
646
|
-
$ kourou es:aliases:cat
|
|
707
|
+
$ kourou es:aliases:cat [--help] [-n <value>] [-g <value>]
|
|
708
|
+
|
|
709
|
+
FLAGS
|
|
710
|
+
-g, --grep=<value> Match output with pattern
|
|
711
|
+
-n, --node=<value> [default: http://localhost:9200] Elasticsearch server URL
|
|
712
|
+
--help Show CLI help.
|
|
647
713
|
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
-n, --node=node [default: http://localhost:9200] Elasticsearch server URL
|
|
651
|
-
--help show CLI help
|
|
714
|
+
DESCRIPTION
|
|
715
|
+
Lists available ES aliases
|
|
652
716
|
```
|
|
653
717
|
|
|
654
|
-
_See code: [
|
|
718
|
+
_See code: [src/commands/es/aliases/cat.ts](src/commands/es/aliases/cat.ts)_
|
|
655
719
|
|
|
656
720
|
## `kourou es:indices:cat`
|
|
657
721
|
|
|
@@ -659,15 +723,18 @@ Lists available ES indexes
|
|
|
659
723
|
|
|
660
724
|
```
|
|
661
725
|
USAGE
|
|
662
|
-
$ kourou es:indices:cat
|
|
726
|
+
$ kourou es:indices:cat [--help] [-n <value>] [-g <value>]
|
|
663
727
|
|
|
664
|
-
|
|
665
|
-
-g, --grep
|
|
666
|
-
-n, --node
|
|
667
|
-
|
|
728
|
+
FLAGS
|
|
729
|
+
-g, --grep=<value> Match output with pattern
|
|
730
|
+
-n, --node=<value> [default: http://localhost:9200] Elasticsearch server URL
|
|
731
|
+
--help Show CLI help.
|
|
732
|
+
|
|
733
|
+
DESCRIPTION
|
|
734
|
+
Lists available ES indexes
|
|
668
735
|
```
|
|
669
736
|
|
|
670
|
-
_See code: [
|
|
737
|
+
_See code: [src/commands/es/indices/cat.ts](src/commands/es/indices/cat.ts)_
|
|
671
738
|
|
|
672
739
|
## `kourou es:indices:get INDEX ID`
|
|
673
740
|
|
|
@@ -675,18 +742,21 @@ Gets a document from ES
|
|
|
675
742
|
|
|
676
743
|
```
|
|
677
744
|
USAGE
|
|
678
|
-
$ kourou es:indices:get INDEX ID
|
|
745
|
+
$ kourou es:indices:get INDEX ID [--help] [-n <value>]
|
|
679
746
|
|
|
680
747
|
ARGUMENTS
|
|
681
748
|
INDEX ES Index name
|
|
682
749
|
ID Document ID
|
|
683
750
|
|
|
684
|
-
|
|
685
|
-
-n, --node
|
|
686
|
-
|
|
751
|
+
FLAGS
|
|
752
|
+
-n, --node=<value> [default: http://localhost:9200] Elasticsearch server URL
|
|
753
|
+
--help Show CLI help.
|
|
754
|
+
|
|
755
|
+
DESCRIPTION
|
|
756
|
+
Gets a document from ES
|
|
687
757
|
```
|
|
688
758
|
|
|
689
|
-
_See code: [
|
|
759
|
+
_See code: [src/commands/es/indices/get.ts](src/commands/es/indices/get.ts)_
|
|
690
760
|
|
|
691
761
|
## `kourou es:indices:insert INDEX`
|
|
692
762
|
|
|
@@ -694,19 +764,22 @@ Inserts a document directly into ES (will replace if exists)
|
|
|
694
764
|
|
|
695
765
|
```
|
|
696
766
|
USAGE
|
|
697
|
-
$ kourou es:indices:insert INDEX
|
|
767
|
+
$ kourou es:indices:insert INDEX [--body <value>] [--id <value>] [-n <value>] [--help]
|
|
698
768
|
|
|
699
769
|
ARGUMENTS
|
|
700
770
|
INDEX ES Index name
|
|
701
771
|
|
|
702
|
-
|
|
703
|
-
-n, --node
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
772
|
+
FLAGS
|
|
773
|
+
-n, --node=<value> [default: http://localhost:9200] Elasticsearch server URL
|
|
774
|
+
--body=<value> [default: {}] Document body in JSON
|
|
775
|
+
--help Show CLI help.
|
|
776
|
+
--id=<value> Document ID
|
|
777
|
+
|
|
778
|
+
DESCRIPTION
|
|
779
|
+
Inserts a document directly into ES (will replace if exists)
|
|
707
780
|
```
|
|
708
781
|
|
|
709
|
-
_See code: [
|
|
782
|
+
_See code: [src/commands/es/indices/insert.ts](src/commands/es/indices/insert.ts)_
|
|
710
783
|
|
|
711
784
|
## `kourou es:migrate`
|
|
712
785
|
|
|
@@ -714,35 +787,43 @@ Migrate all the index from an Elasticsearch (or a file) to another Elasticsearch
|
|
|
714
787
|
|
|
715
788
|
```
|
|
716
789
|
USAGE
|
|
717
|
-
$ kourou es:migrate
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
--
|
|
722
|
-
--
|
|
723
|
-
--
|
|
724
|
-
--
|
|
725
|
-
|
|
726
|
-
--
|
|
727
|
-
--
|
|
728
|
-
--
|
|
729
|
-
--
|
|
730
|
-
--
|
|
790
|
+
$ kourou es:migrate --src <value> --dest <value> [--help] [--reset] [--batch-size <value>] [--no-interactive]
|
|
791
|
+
[--dry-run] [--pattern <value>] [--scroll <value>] [--only-mappings] [--esVersion 7|8]
|
|
792
|
+
|
|
793
|
+
FLAGS
|
|
794
|
+
--batch-size=<value> [default: 1000] How many documents to move in batch per operation
|
|
795
|
+
--dest=<value> (required) [env: KUZZLE_MIGRATION_DEST] Migration destination provider
|
|
796
|
+
--dry-run Print witch collections will be migrated
|
|
797
|
+
--esVersion=<option> [default: 7] Elasticsearch version to use for the migration
|
|
798
|
+
<options: 7|8>
|
|
799
|
+
--help Show CLI help.
|
|
800
|
+
--no-interactive Skip confirmation interactive prompts (perfect for scripting)
|
|
801
|
+
--only-mappings Only migrate mappings
|
|
802
|
+
--pattern=<value> Pattern to match indices to migrate
|
|
803
|
+
--reset Reset destination Elasticsearch server
|
|
804
|
+
--scroll=<value> [default: 30s] Scroll duration for Elasticsearch scrolling
|
|
805
|
+
--src=<value> (required) [env: KUZZLE_MIGRATION_SRC] Migration source provider
|
|
806
|
+
|
|
807
|
+
DESCRIPTION
|
|
808
|
+
Migrate all the index from an Elasticsearch (or a file) to another Elasticsearch
|
|
731
809
|
|
|
732
810
|
EXAMPLES
|
|
733
|
-
kourou es:migrate --src http://elasticsearch:9200 --dest ./my-backup
|
|
734
|
-
|
|
735
|
-
kourou es:migrate --src ./my-backup --dest http://
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
|
|
741
|
-
kourou es:migrate --src
|
|
742
|
-
|
|
811
|
+
$ kourou es:migrate --src http://elasticsearch:9200 --dest ./my-backup
|
|
812
|
+
|
|
813
|
+
$ kourou es:migrate --src ./my-backup --dest http://elasticsearch:9200
|
|
814
|
+
|
|
815
|
+
$ kourou es:migrate --src ./my-backup --dest http://username:password@elasticsearch:9200 --reset
|
|
816
|
+
|
|
817
|
+
$ kourou es:migrate --src ./my-backup --dest http://nologin:api-key@elasticsearch:9200 --reset // nologin is a special username that allows you to use an API key as password
|
|
818
|
+
|
|
819
|
+
$ kourou es:migrate --src http://elasticsearch:9200 --dest ./my-backup --batch-size 2000 --pattern '&myindexes.collection-*'
|
|
820
|
+
|
|
821
|
+
$ kourou es:migrate --src ./my-backup --dest http://elasticsearch:9200 --reset --batch-size 2000 --no-interactive
|
|
822
|
+
|
|
823
|
+
$ kourou es:migrate --src ./my-backup --dest http://elasticsearch:9200 --reset --batch-size 2000 --no-interactive --esVersion 8
|
|
743
824
|
```
|
|
744
825
|
|
|
745
|
-
_See code: [
|
|
826
|
+
_See code: [src/commands/es/migrate.ts](src/commands/es/migrate.ts)_
|
|
746
827
|
|
|
747
828
|
## `kourou es:snapshot:create REPOSITORY NAME`
|
|
748
829
|
|
|
@@ -750,21 +831,23 @@ Create a snapshot repository inside an ES instance
|
|
|
750
831
|
|
|
751
832
|
```
|
|
752
833
|
USAGE
|
|
753
|
-
$ kourou es:snapshot:create REPOSITORY NAME
|
|
834
|
+
$ kourou es:snapshot:create REPOSITORY NAME [-n <value>] [--wait] [--help]
|
|
754
835
|
|
|
755
836
|
ARGUMENTS
|
|
756
837
|
REPOSITORY ES repository name
|
|
757
838
|
NAME ES snapshot name
|
|
758
839
|
|
|
759
|
-
|
|
760
|
-
-n, --node
|
|
761
|
-
|
|
840
|
+
FLAGS
|
|
841
|
+
-n, --node=<value> [default: http://localhost:9200] Elasticsearch server URL
|
|
842
|
+
--help Show CLI help.
|
|
843
|
+
--[no-]wait Wait for the snapshot to complete before returning. Use --no-wait to return as soon as
|
|
844
|
+
Elasticsearch has accepted the request
|
|
762
845
|
|
|
763
|
-
|
|
764
|
-
|
|
846
|
+
DESCRIPTION
|
|
847
|
+
Create a snapshot repository inside an ES instance
|
|
765
848
|
```
|
|
766
849
|
|
|
767
|
-
_See code: [
|
|
850
|
+
_See code: [src/commands/es/snapshot/create.ts](src/commands/es/snapshot/create.ts)_
|
|
768
851
|
|
|
769
852
|
## `kourou es:snapshot:create-repository REPOSITORY LOCATION`
|
|
770
853
|
|
|
@@ -772,19 +855,22 @@ Create a FS snapshot repository inside an ES instance
|
|
|
772
855
|
|
|
773
856
|
```
|
|
774
857
|
USAGE
|
|
775
|
-
$ kourou es:snapshot:create-repository REPOSITORY LOCATION
|
|
858
|
+
$ kourou es:snapshot:create-repository REPOSITORY LOCATION [--compress] [-n <value>] [--help]
|
|
776
859
|
|
|
777
860
|
ARGUMENTS
|
|
778
861
|
REPOSITORY ES repository name
|
|
779
862
|
LOCATION ES snapshot repository location
|
|
780
863
|
|
|
781
|
-
|
|
782
|
-
-n, --node
|
|
783
|
-
|
|
784
|
-
|
|
864
|
+
FLAGS
|
|
865
|
+
-n, --node=<value> [default: http://localhost:9200] Elasticsearch server URL
|
|
866
|
+
--compress Compress data when storing them
|
|
867
|
+
--help Show CLI help.
|
|
868
|
+
|
|
869
|
+
DESCRIPTION
|
|
870
|
+
Create a FS snapshot repository inside an ES instance
|
|
785
871
|
```
|
|
786
872
|
|
|
787
|
-
_See code: [
|
|
873
|
+
_See code: [src/commands/es/snapshot/create-repository.ts](src/commands/es/snapshot/create-repository.ts)_
|
|
788
874
|
|
|
789
875
|
## `kourou es:snapshot:list REPOSITORY`
|
|
790
876
|
|
|
@@ -792,17 +878,20 @@ List all snapshot from a repository acknowledge by an ES instance
|
|
|
792
878
|
|
|
793
879
|
```
|
|
794
880
|
USAGE
|
|
795
|
-
$ kourou es:snapshot:list REPOSITORY
|
|
881
|
+
$ kourou es:snapshot:list REPOSITORY [-n <value>] [--help]
|
|
796
882
|
|
|
797
883
|
ARGUMENTS
|
|
798
884
|
REPOSITORY Name of repository from which to fetch the snapshot information
|
|
799
885
|
|
|
800
|
-
|
|
801
|
-
-n, --node
|
|
802
|
-
|
|
886
|
+
FLAGS
|
|
887
|
+
-n, --node=<value> [default: http://localhost:9200] Elasticsearch server URL
|
|
888
|
+
--help Show CLI help.
|
|
889
|
+
|
|
890
|
+
DESCRIPTION
|
|
891
|
+
List all snapshot from a repository acknowledge by an ES instance
|
|
803
892
|
```
|
|
804
893
|
|
|
805
|
-
_See code: [
|
|
894
|
+
_See code: [src/commands/es/snapshot/list.ts](src/commands/es/snapshot/list.ts)_
|
|
806
895
|
|
|
807
896
|
## `kourou es:snapshot:restore REPOSITORY NAME`
|
|
808
897
|
|
|
@@ -810,21 +899,23 @@ Restore a snapshot repository inside an ES instance
|
|
|
810
899
|
|
|
811
900
|
```
|
|
812
901
|
USAGE
|
|
813
|
-
$ kourou es:snapshot:restore REPOSITORY NAME
|
|
902
|
+
$ kourou es:snapshot:restore REPOSITORY NAME [-n <value>] [--wait] [--help]
|
|
814
903
|
|
|
815
904
|
ARGUMENTS
|
|
816
905
|
REPOSITORY ES repository name
|
|
817
906
|
NAME ES snapshot name
|
|
818
907
|
|
|
819
|
-
|
|
820
|
-
-n, --node
|
|
821
|
-
|
|
908
|
+
FLAGS
|
|
909
|
+
-n, --node=<value> [default: http://localhost:9200] Elasticsearch server URL
|
|
910
|
+
--help Show CLI help.
|
|
911
|
+
--[no-]wait Wait for the restore to complete before returning. Use --no-wait to return as soon as
|
|
912
|
+
Elasticsearch has accepted the request
|
|
822
913
|
|
|
823
|
-
|
|
824
|
-
|
|
914
|
+
DESCRIPTION
|
|
915
|
+
Restore a snapshot repository inside an ES instance
|
|
825
916
|
```
|
|
826
917
|
|
|
827
|
-
_See code: [
|
|
918
|
+
_See code: [src/commands/es/snapshot/restore.ts](src/commands/es/snapshot/restore.ts)_
|
|
828
919
|
|
|
829
920
|
## `kourou file:decrypt FILE`
|
|
830
921
|
|
|
@@ -832,22 +923,26 @@ Decrypts an encrypted file.
|
|
|
832
923
|
|
|
833
924
|
```
|
|
834
925
|
USAGE
|
|
835
|
-
$ kourou file:decrypt FILE
|
|
926
|
+
$ kourou file:decrypt FILE [-f] [-o <value>] [--vault-key <value>]
|
|
836
927
|
|
|
837
928
|
ARGUMENTS
|
|
838
929
|
FILE Encrypted file
|
|
839
930
|
|
|
840
|
-
|
|
841
|
-
-f, --force
|
|
842
|
-
-o, --output-file
|
|
843
|
-
|
|
931
|
+
FLAGS
|
|
932
|
+
-f, --force Overwrite the output file if it already exists
|
|
933
|
+
-o, --output-file=<value> Output file (default: remove ".enc")
|
|
934
|
+
--vault-key=<value> Kuzzle Vault Key (or KUZZLE_VAULT_KEY)
|
|
935
|
+
|
|
936
|
+
DESCRIPTION
|
|
937
|
+
Decrypts an encrypted file.
|
|
844
938
|
|
|
845
939
|
EXAMPLES
|
|
846
|
-
kourou file:decrypt books/cryptonomicon.txt.enc --vault-key <vault-key>
|
|
847
|
-
|
|
940
|
+
$ kourou file:decrypt books/cryptonomicon.txt.enc --vault-key <vault-key>
|
|
941
|
+
|
|
942
|
+
$ kourou file:decrypt books/cryptonomicon.txt.enc -o books/cryptonomicon.txt --vault-key <vault-key>
|
|
848
943
|
```
|
|
849
944
|
|
|
850
|
-
_See code: [
|
|
945
|
+
_See code: [src/commands/file/decrypt.ts](src/commands/file/decrypt.ts)_
|
|
851
946
|
|
|
852
947
|
## `kourou file:encrypt FILE`
|
|
853
948
|
|
|
@@ -855,22 +950,26 @@ Encrypts an entire file.
|
|
|
855
950
|
|
|
856
951
|
```
|
|
857
952
|
USAGE
|
|
858
|
-
$ kourou file:encrypt FILE
|
|
953
|
+
$ kourou file:encrypt FILE [-f] [-o <value>] [--vault-key <value>]
|
|
859
954
|
|
|
860
955
|
ARGUMENTS
|
|
861
956
|
FILE Filename
|
|
862
957
|
|
|
863
|
-
|
|
864
|
-
-f, --force
|
|
865
|
-
-o, --output-file
|
|
866
|
-
|
|
958
|
+
FLAGS
|
|
959
|
+
-f, --force Overwrite the output file if it already exists
|
|
960
|
+
-o, --output-file=<value> Output file (default: <filename>.enc)
|
|
961
|
+
--vault-key=<value> Kuzzle Vault Key (or KUZZLE_VAULT_KEY)
|
|
962
|
+
|
|
963
|
+
DESCRIPTION
|
|
964
|
+
Encrypts an entire file.
|
|
867
965
|
|
|
868
966
|
EXAMPLES
|
|
869
|
-
kourou file:encrypt books/cryptonomicon.txt --vault-key <vault-key>
|
|
870
|
-
|
|
967
|
+
$ kourou file:encrypt books/cryptonomicon.txt --vault-key <vault-key>
|
|
968
|
+
|
|
969
|
+
$ kourou file:encrypt books/cryptonomicon.txt -o books/cryptonomicon.txt.enc --vault-key <vault-key>
|
|
871
970
|
```
|
|
872
971
|
|
|
873
|
-
_See code: [
|
|
972
|
+
_See code: [src/commands/file/encrypt.ts](src/commands/file/encrypt.ts)_
|
|
874
973
|
|
|
875
974
|
## `kourou file:test FILE`
|
|
876
975
|
|
|
@@ -878,36 +977,42 @@ Tests if an encrypted file can be decrypted.
|
|
|
878
977
|
|
|
879
978
|
```
|
|
880
979
|
USAGE
|
|
881
|
-
$ kourou file:test FILE
|
|
980
|
+
$ kourou file:test FILE [--vault-key <value>]
|
|
882
981
|
|
|
883
982
|
ARGUMENTS
|
|
884
983
|
FILE Encrypted file
|
|
885
984
|
|
|
886
|
-
|
|
887
|
-
--vault-key
|
|
985
|
+
FLAGS
|
|
986
|
+
--vault-key=<value> Kuzzle Vault Key (or KUZZLE_VAULT_KEY)
|
|
987
|
+
|
|
988
|
+
DESCRIPTION
|
|
989
|
+
Tests if an encrypted file can be decrypted.
|
|
888
990
|
|
|
889
|
-
|
|
890
|
-
kourou file:test books/cryptonomicon.txt.enc --vault-key <vault-key>
|
|
991
|
+
EXAMPLES
|
|
992
|
+
$ kourou file:test books/cryptonomicon.txt.enc --vault-key <vault-key>
|
|
891
993
|
```
|
|
892
994
|
|
|
893
|
-
_See code: [
|
|
995
|
+
_See code: [src/commands/file/test.ts](src/commands/file/test.ts)_
|
|
894
996
|
|
|
895
997
|
## `kourou help [COMMAND]`
|
|
896
998
|
|
|
897
|
-
|
|
999
|
+
Display help for kourou.
|
|
898
1000
|
|
|
899
1001
|
```
|
|
900
1002
|
USAGE
|
|
901
|
-
$ kourou help [COMMAND]
|
|
1003
|
+
$ kourou help [COMMAND...] [-n]
|
|
902
1004
|
|
|
903
1005
|
ARGUMENTS
|
|
904
|
-
COMMAND
|
|
1006
|
+
[COMMAND...] Command to show help for.
|
|
1007
|
+
|
|
1008
|
+
FLAGS
|
|
1009
|
+
-n, --nested-commands Include all nested commands in the output.
|
|
905
1010
|
|
|
906
|
-
|
|
907
|
-
|
|
1011
|
+
DESCRIPTION
|
|
1012
|
+
Display help for kourou.
|
|
908
1013
|
```
|
|
909
1014
|
|
|
910
|
-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/
|
|
1015
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/7.0.0/src/commands/help.ts)_
|
|
911
1016
|
|
|
912
1017
|
## `kourou import PATH`
|
|
913
1018
|
|
|
@@ -915,26 +1020,30 @@ Recursively imports dump files from a root directory
|
|
|
915
1020
|
|
|
916
1021
|
```
|
|
917
1022
|
USAGE
|
|
918
|
-
$ kourou import PATH
|
|
1023
|
+
$ kourou import PATH [--preserve-anonymous] [--help] [--batch-size <value>] [--host <value>] [--port
|
|
1024
|
+
<value>] [--ssl] [--username <value>] [--password <value>] [--protocol <value>] [--as <value>] [--api-key <value>]
|
|
919
1025
|
|
|
920
1026
|
ARGUMENTS
|
|
921
1027
|
PATH Root directory containing dumps
|
|
922
1028
|
|
|
923
|
-
|
|
924
|
-
--api-key
|
|
925
|
-
--as
|
|
926
|
-
--batch-size
|
|
927
|
-
--help
|
|
928
|
-
--host
|
|
929
|
-
--password
|
|
930
|
-
--port
|
|
931
|
-
--preserve-anonymous
|
|
932
|
-
--protocol
|
|
933
|
-
--ssl
|
|
934
|
-
--username
|
|
1029
|
+
FLAGS
|
|
1030
|
+
--api-key=<value> Kuzzle user api-key
|
|
1031
|
+
--as=<value> Impersonate a user
|
|
1032
|
+
--batch-size=<value> [default: 200] Maximum batch size (see limits.documentsWriteCount config)
|
|
1033
|
+
--help Show CLI help.
|
|
1034
|
+
--host=<value> [default: localhost] Kuzzle server host
|
|
1035
|
+
--password=<value> Kuzzle user password
|
|
1036
|
+
--port=<value> [default: 7512] Kuzzle server port
|
|
1037
|
+
--preserve-anonymous Preserve anonymous rights
|
|
1038
|
+
--protocol=<value> [default: ws] Kuzzle protocol (http or websocket)
|
|
1039
|
+
--ssl Use SSL to connect to Kuzzle
|
|
1040
|
+
--username=<value> [default: anonymous] Kuzzle username (local strategy)
|
|
1041
|
+
|
|
1042
|
+
DESCRIPTION
|
|
1043
|
+
Recursively imports dump files from a root directory
|
|
935
1044
|
```
|
|
936
1045
|
|
|
937
|
-
_See code: [
|
|
1046
|
+
_See code: [src/commands/import.ts](src/commands/import.ts)_
|
|
938
1047
|
|
|
939
1048
|
## `kourou index:export INDEX`
|
|
940
1049
|
|
|
@@ -942,49 +1051,43 @@ Exports an index (JSONL or Kuzzle format)
|
|
|
942
1051
|
|
|
943
1052
|
```
|
|
944
1053
|
USAGE
|
|
945
|
-
$ kourou index:export INDEX
|
|
1054
|
+
$ kourou index:export INDEX [--help] [--path <value>] [--batch-size <value>] [--query <value>] [--format
|
|
1055
|
+
<value>] [--scrollTTL <value>] [--host <value>] [--port <value>] [--ssl] [--username <value>] [--password <value>]
|
|
1056
|
+
[--protocol <value>] [--as <value>] [--api-key <value>] [--type <value>]
|
|
946
1057
|
|
|
947
1058
|
ARGUMENTS
|
|
948
1059
|
INDEX Index name
|
|
949
1060
|
|
|
950
|
-
|
|
951
|
-
--api-key
|
|
952
|
-
--as
|
|
953
|
-
--batch-size
|
|
954
|
-
|
|
955
|
-
|
|
956
|
-
|
|
957
|
-
|
|
958
|
-
--
|
|
959
|
-
|
|
960
|
-
--
|
|
961
|
-
|
|
962
|
-
--
|
|
963
|
-
|
|
964
|
-
|
|
965
|
-
|
|
966
|
-
--
|
|
967
|
-
|
|
968
|
-
--
|
|
969
|
-
|
|
970
|
-
--query=query [default: {}] Only dump documents in collections matching the query (JS or JSON format)
|
|
971
|
-
|
|
972
|
-
--scrollTTL=scrollTTL [default: 20s] The scroll TTL option to pass to the dump operation (which performs a
|
|
973
|
-
document.search under the hood),
|
|
974
|
-
expressed in ms format, e.g. '2s', '1m', '3h'.
|
|
975
|
-
|
|
976
|
-
--ssl Use SSL to connect to Kuzzle
|
|
977
|
-
|
|
978
|
-
--type=type [default: all] Type of the export: all, mappings, data
|
|
1061
|
+
FLAGS
|
|
1062
|
+
--api-key=<value> Kuzzle user api-key
|
|
1063
|
+
--as=<value> Impersonate a user
|
|
1064
|
+
--batch-size=<value> [default: 2000] Maximum batch size (see limits.documentsFetchCount config)
|
|
1065
|
+
--format=<value> [default: jsonl] "jsonl or kuzzle - kuzzle will export in Kuzzle format usable for internal
|
|
1066
|
+
fixtures and jsonl allows to import that data back with kourou
|
|
1067
|
+
--help Show CLI help.
|
|
1068
|
+
--host=<value> [default: localhost] Kuzzle server host
|
|
1069
|
+
--password=<value> Kuzzle user password
|
|
1070
|
+
--path=<value> Dump root directory
|
|
1071
|
+
--port=<value> [default: 7512] Kuzzle server port
|
|
1072
|
+
--protocol=<value> [default: ws] Kuzzle protocol (http or websocket)
|
|
1073
|
+
--query=<value> [default: {}] Only dump documents in collections matching the query (JS or JSON format)
|
|
1074
|
+
--scrollTTL=<value> [default: 20s] The scroll TTL option to pass to the dump operation (which performs a
|
|
1075
|
+
document.search under the hood),
|
|
1076
|
+
expressed in ms format, e.g. '2s', '1m', '3h'.
|
|
1077
|
+
--ssl Use SSL to connect to Kuzzle
|
|
1078
|
+
--type=<value> [default: all] Type of the export: all, mappings, data
|
|
1079
|
+
--username=<value> [default: anonymous] Kuzzle username (local strategy)
|
|
979
1080
|
|
|
980
|
-
|
|
1081
|
+
DESCRIPTION
|
|
1082
|
+
Exports an index (JSONL or Kuzzle format)
|
|
981
1083
|
|
|
982
1084
|
EXAMPLES
|
|
983
|
-
kourou index:export nyc-open-data
|
|
984
|
-
|
|
1085
|
+
$ kourou index:export nyc-open-data
|
|
1086
|
+
|
|
1087
|
+
$ kourou index:export nyc-open-data --query '{"range":{"_kuzzle_info.createdAt":{"gt":1632935638866}}}'
|
|
985
1088
|
```
|
|
986
1089
|
|
|
987
|
-
_See code: [
|
|
1090
|
+
_See code: [src/commands/index/export.ts](src/commands/index/export.ts)_
|
|
988
1091
|
|
|
989
1092
|
## `kourou index:import PATH`
|
|
990
1093
|
|
|
@@ -992,31 +1095,37 @@ Imports an index (JSONL format)
|
|
|
992
1095
|
|
|
993
1096
|
```
|
|
994
1097
|
USAGE
|
|
995
|
-
$ kourou index:import PATH
|
|
1098
|
+
$ kourou index:import PATH [--help] [--batch-size <value>] [--index <value>] [--no-mappings] [--host <value>]
|
|
1099
|
+
[--port <value>] [--ssl] [--username <value>] [--password <value>] [--protocol <value>] [--as <value>] [--api-key
|
|
1100
|
+
<value>]
|
|
996
1101
|
|
|
997
1102
|
ARGUMENTS
|
|
998
1103
|
PATH Dump directory or file
|
|
999
1104
|
|
|
1000
|
-
|
|
1001
|
-
--api-key
|
|
1002
|
-
--as
|
|
1003
|
-
--batch-size
|
|
1004
|
-
--help
|
|
1005
|
-
--host
|
|
1006
|
-
--index
|
|
1007
|
-
--no-mappings
|
|
1008
|
-
--password
|
|
1009
|
-
--port
|
|
1010
|
-
--protocol
|
|
1011
|
-
--ssl
|
|
1012
|
-
--username
|
|
1105
|
+
FLAGS
|
|
1106
|
+
--api-key=<value> Kuzzle user api-key
|
|
1107
|
+
--as=<value> Impersonate a user
|
|
1108
|
+
--batch-size=<value> [default: 200] Maximum batch size (see limits.documentsWriteCount config)
|
|
1109
|
+
--help Show CLI help.
|
|
1110
|
+
--host=<value> [default: localhost] Kuzzle server host
|
|
1111
|
+
--index=<value> If set, override the index destination name
|
|
1112
|
+
--no-mappings Skip collections mappings
|
|
1113
|
+
--password=<value> Kuzzle user password
|
|
1114
|
+
--port=<value> [default: 7512] Kuzzle server port
|
|
1115
|
+
--protocol=<value> [default: ws] Kuzzle protocol (http or websocket)
|
|
1116
|
+
--ssl Use SSL to connect to Kuzzle
|
|
1117
|
+
--username=<value> [default: anonymous] Kuzzle username (local strategy)
|
|
1118
|
+
|
|
1119
|
+
DESCRIPTION
|
|
1120
|
+
Imports an index (JSONL format)
|
|
1013
1121
|
|
|
1014
1122
|
EXAMPLES
|
|
1015
|
-
kourou index:import ./dump/iot-data
|
|
1016
|
-
|
|
1123
|
+
$ kourou index:import ./dump/iot-data
|
|
1124
|
+
|
|
1125
|
+
$ kourou index:import ./dump/iot-data --index iot-data-production --no-mappings
|
|
1017
1126
|
```
|
|
1018
1127
|
|
|
1019
|
-
_See code: [
|
|
1128
|
+
_See code: [src/commands/index/import.ts](src/commands/index/import.ts)_
|
|
1020
1129
|
|
|
1021
1130
|
## `kourou instance:kill`
|
|
1022
1131
|
|
|
@@ -1024,14 +1133,17 @@ Stop and remove all the containers of a running kuzzle instance
|
|
|
1024
1133
|
|
|
1025
1134
|
```
|
|
1026
1135
|
USAGE
|
|
1027
|
-
$ kourou instance:kill
|
|
1136
|
+
$ kourou instance:kill [-i <value>] [-a]
|
|
1137
|
+
|
|
1138
|
+
FLAGS
|
|
1139
|
+
-a, --all Kill all instances
|
|
1140
|
+
-i, --instance=<value> Kuzzle instance name [ex: stack-0]
|
|
1028
1141
|
|
|
1029
|
-
|
|
1030
|
-
|
|
1031
|
-
-i, --instance=instance Kuzzle instance name [ex: stack-0]
|
|
1142
|
+
DESCRIPTION
|
|
1143
|
+
Stop and remove all the containers of a running kuzzle instance
|
|
1032
1144
|
```
|
|
1033
1145
|
|
|
1034
|
-
_See code: [
|
|
1146
|
+
_See code: [src/commands/instance/kill.ts](src/commands/instance/kill.ts)_
|
|
1035
1147
|
|
|
1036
1148
|
## `kourou instance:list`
|
|
1037
1149
|
|
|
@@ -1040,9 +1152,12 @@ Lists the Kuzzle running instances
|
|
|
1040
1152
|
```
|
|
1041
1153
|
USAGE
|
|
1042
1154
|
$ kourou instance:list
|
|
1155
|
+
|
|
1156
|
+
DESCRIPTION
|
|
1157
|
+
Lists the Kuzzle running instances
|
|
1043
1158
|
```
|
|
1044
1159
|
|
|
1045
|
-
_See code: [
|
|
1160
|
+
_See code: [src/commands/instance/list.ts](src/commands/instance/list.ts)_
|
|
1046
1161
|
|
|
1047
1162
|
## `kourou instance:logs`
|
|
1048
1163
|
|
|
@@ -1050,14 +1165,17 @@ Displays the logs of a running Kuzzle
|
|
|
1050
1165
|
|
|
1051
1166
|
```
|
|
1052
1167
|
USAGE
|
|
1053
|
-
$ kourou instance:logs
|
|
1168
|
+
$ kourou instance:logs [-i <value>] [-f]
|
|
1169
|
+
|
|
1170
|
+
FLAGS
|
|
1171
|
+
-f, --follow Follow log output
|
|
1172
|
+
-i, --instance=<value> Kuzzle instance name
|
|
1054
1173
|
|
|
1055
|
-
|
|
1056
|
-
|
|
1057
|
-
-i, --instance=instance Kuzzle instance name
|
|
1174
|
+
DESCRIPTION
|
|
1175
|
+
Displays the logs of a running Kuzzle
|
|
1058
1176
|
```
|
|
1059
1177
|
|
|
1060
|
-
_See code: [
|
|
1178
|
+
_See code: [src/commands/instance/logs.ts](src/commands/instance/logs.ts)_
|
|
1061
1179
|
|
|
1062
1180
|
## `kourou instance:spawn`
|
|
1063
1181
|
|
|
@@ -1065,15 +1183,18 @@ Spawn a new Kuzzle instance
|
|
|
1065
1183
|
|
|
1066
1184
|
```
|
|
1067
1185
|
USAGE
|
|
1068
|
-
$ kourou instance:spawn
|
|
1186
|
+
$ kourou instance:spawn [--help] [--check] [-v <value>]
|
|
1187
|
+
|
|
1188
|
+
FLAGS
|
|
1189
|
+
-v, --version=<value> [default: 2] Core-version of the instance to spawn
|
|
1190
|
+
--check Check prerequisite before running Kuzzle
|
|
1191
|
+
--help Show CLI help.
|
|
1069
1192
|
|
|
1070
|
-
|
|
1071
|
-
|
|
1072
|
-
--check Check prerequisite before running Kuzzle
|
|
1073
|
-
--help show CLI help
|
|
1193
|
+
DESCRIPTION
|
|
1194
|
+
Spawn a new Kuzzle instance
|
|
1074
1195
|
```
|
|
1075
1196
|
|
|
1076
|
-
_See code: [
|
|
1197
|
+
_See code: [src/commands/instance/spawn.ts](src/commands/instance/spawn.ts)_
|
|
1077
1198
|
|
|
1078
1199
|
## `kourou paas:login`
|
|
1079
1200
|
|
|
@@ -1081,16 +1202,19 @@ Login for a PaaS project
|
|
|
1081
1202
|
|
|
1082
1203
|
```
|
|
1083
1204
|
USAGE
|
|
1084
|
-
$ kourou paas:login
|
|
1205
|
+
$ kourou paas:login [--help] [--project <value>] [--username <value>] [--only_npm]
|
|
1085
1206
|
|
|
1086
|
-
|
|
1087
|
-
--help
|
|
1088
|
-
--only_npm
|
|
1089
|
-
--project
|
|
1090
|
-
--username
|
|
1207
|
+
FLAGS
|
|
1208
|
+
--help Show CLI help.
|
|
1209
|
+
--only_npm Only perform the login on the private NPM registry
|
|
1210
|
+
--project=<value> Current PaaS project
|
|
1211
|
+
--username=<value> PaaS username
|
|
1212
|
+
|
|
1213
|
+
DESCRIPTION
|
|
1214
|
+
Login for a PaaS project
|
|
1091
1215
|
```
|
|
1092
1216
|
|
|
1093
|
-
_See code: [
|
|
1217
|
+
_See code: [src/commands/paas/login.ts](src/commands/paas/login.ts)_
|
|
1094
1218
|
|
|
1095
1219
|
## `kourou profile:export`
|
|
1096
1220
|
|
|
@@ -1098,22 +1222,26 @@ Exports profiles
|
|
|
1098
1222
|
|
|
1099
1223
|
```
|
|
1100
1224
|
USAGE
|
|
1101
|
-
$ kourou profile:export
|
|
1225
|
+
$ kourou profile:export [--help] [--path <value>] [--host <value>] [--port <value>] [--ssl] [--username <value>]
|
|
1226
|
+
[--password <value>] [--protocol <value>] [--as <value>] [--api-key <value>]
|
|
1227
|
+
|
|
1228
|
+
FLAGS
|
|
1229
|
+
--api-key=<value> Kuzzle user api-key
|
|
1230
|
+
--as=<value> Impersonate a user
|
|
1231
|
+
--help Show CLI help.
|
|
1232
|
+
--host=<value> [default: localhost] Kuzzle server host
|
|
1233
|
+
--password=<value> Kuzzle user password
|
|
1234
|
+
--path=<value> [default: profiles] Dump directory
|
|
1235
|
+
--port=<value> [default: 7512] Kuzzle server port
|
|
1236
|
+
--protocol=<value> [default: ws] Kuzzle protocol (http or websocket)
|
|
1237
|
+
--ssl Use SSL to connect to Kuzzle
|
|
1238
|
+
--username=<value> [default: anonymous] Kuzzle username (local strategy)
|
|
1102
1239
|
|
|
1103
|
-
|
|
1104
|
-
|
|
1105
|
-
--as=as Impersonate a user
|
|
1106
|
-
--help show CLI help
|
|
1107
|
-
--host=host [default: localhost] Kuzzle server host
|
|
1108
|
-
--password=password Kuzzle user password
|
|
1109
|
-
--path=path [default: profiles] Dump directory
|
|
1110
|
-
--port=port [default: 7512] Kuzzle server port
|
|
1111
|
-
--protocol=protocol [default: ws] Kuzzle protocol (http or websocket)
|
|
1112
|
-
--ssl Use SSL to connect to Kuzzle
|
|
1113
|
-
--username=username [default: anonymous] Kuzzle username (local strategy)
|
|
1240
|
+
DESCRIPTION
|
|
1241
|
+
Exports profiles
|
|
1114
1242
|
```
|
|
1115
1243
|
|
|
1116
|
-
_See code: [
|
|
1244
|
+
_See code: [src/commands/profile/export.ts](src/commands/profile/export.ts)_
|
|
1117
1245
|
|
|
1118
1246
|
## `kourou profile:import PATH`
|
|
1119
1247
|
|
|
@@ -1121,24 +1249,28 @@ Imports profiles
|
|
|
1121
1249
|
|
|
1122
1250
|
```
|
|
1123
1251
|
USAGE
|
|
1124
|
-
$ kourou profile:import PATH
|
|
1252
|
+
$ kourou profile:import PATH [--help] [--host <value>] [--port <value>] [--ssl] [--username <value>] [--password
|
|
1253
|
+
<value>] [--protocol <value>] [--as <value>] [--api-key <value>]
|
|
1125
1254
|
|
|
1126
1255
|
ARGUMENTS
|
|
1127
1256
|
PATH Dump file
|
|
1128
1257
|
|
|
1129
|
-
|
|
1130
|
-
--api-key
|
|
1131
|
-
--as
|
|
1132
|
-
--help
|
|
1133
|
-
--host
|
|
1134
|
-
--password
|
|
1135
|
-
--port
|
|
1136
|
-
--protocol
|
|
1137
|
-
--ssl
|
|
1138
|
-
--username
|
|
1258
|
+
FLAGS
|
|
1259
|
+
--api-key=<value> Kuzzle user api-key
|
|
1260
|
+
--as=<value> Impersonate a user
|
|
1261
|
+
--help Show CLI help.
|
|
1262
|
+
--host=<value> [default: localhost] Kuzzle server host
|
|
1263
|
+
--password=<value> Kuzzle user password
|
|
1264
|
+
--port=<value> [default: 7512] Kuzzle server port
|
|
1265
|
+
--protocol=<value> [default: ws] Kuzzle protocol (http or websocket)
|
|
1266
|
+
--ssl Use SSL to connect to Kuzzle
|
|
1267
|
+
--username=<value> [default: anonymous] Kuzzle username (local strategy)
|
|
1268
|
+
|
|
1269
|
+
DESCRIPTION
|
|
1270
|
+
Imports profiles
|
|
1139
1271
|
```
|
|
1140
1272
|
|
|
1141
|
-
_See code: [
|
|
1273
|
+
_See code: [src/commands/profile/import.ts](src/commands/profile/import.ts)_
|
|
1142
1274
|
|
|
1143
1275
|
## `kourou realtime:subscribe INDEX COLLECTION [FILTERS]`
|
|
1144
1276
|
|
|
@@ -1146,51 +1278,48 @@ Subscribes to realtime notifications
|
|
|
1146
1278
|
|
|
1147
1279
|
```
|
|
1148
1280
|
USAGE
|
|
1149
|
-
$ kourou realtime:subscribe INDEX COLLECTION [FILTERS]
|
|
1281
|
+
$ kourou realtime:subscribe INDEX COLLECTION [FILTERS] [--scope <value>] [--users <value>] [--volatile <value>]
|
|
1282
|
+
[--display <value>] [--editor] [--help] [--host <value>] [--port <value>] [--ssl] [--username <value>] [--password
|
|
1283
|
+
<value>] [--protocol <value>] [--as <value>] [--api-key <value>]
|
|
1150
1284
|
|
|
1151
1285
|
ARGUMENTS
|
|
1152
1286
|
INDEX Index name
|
|
1153
1287
|
COLLECTION Collection name
|
|
1154
|
-
FILTERS
|
|
1155
|
-
|
|
1156
|
-
|
|
1157
|
-
--api-key
|
|
1158
|
-
--as
|
|
1159
|
-
|
|
1160
|
-
|
|
1161
|
-
|
|
1162
|
-
|
|
1163
|
-
--
|
|
1164
|
-
|
|
1165
|
-
--
|
|
1166
|
-
|
|
1167
|
-
--
|
|
1168
|
-
|
|
1169
|
-
--
|
|
1170
|
-
|
|
1171
|
-
--
|
|
1172
|
-
|
|
1173
|
-
--protocol=protocol [default: websocket] Kuzzle protocol (only websocket for realtime)
|
|
1288
|
+
[FILTERS] Set of Koncorde filters
|
|
1289
|
+
|
|
1290
|
+
FLAGS
|
|
1291
|
+
--api-key=<value> Kuzzle user api-key
|
|
1292
|
+
--as=<value> Impersonate a user
|
|
1293
|
+
--display=<value> [default: result] Path of the property to display from the notification (empty string to display
|
|
1294
|
+
everything)
|
|
1295
|
+
--editor Open an editor (EDITOR env variable) to edit the filters before subscribing.
|
|
1296
|
+
--help Show CLI help.
|
|
1297
|
+
--host=<value> [default: localhost] Kuzzle server host
|
|
1298
|
+
--password=<value> Kuzzle user password
|
|
1299
|
+
--port=<value> [default: 7512] Kuzzle server port
|
|
1300
|
+
--protocol=<value> [default: websocket] Kuzzle protocol (only websocket for realtime)
|
|
1301
|
+
--scope=<value> [default: all] Subscribe to document entering or leaving the scope (all, in, out, none)
|
|
1302
|
+
--ssl Use SSL to connect to Kuzzle
|
|
1303
|
+
--username=<value> [default: anonymous] Kuzzle username (local strategy)
|
|
1304
|
+
--users=<value> [default: all] Subscribe to users entering or leaving the room (all, in, out, none)
|
|
1305
|
+
--volatile=<value> [default: {}] Additional subscription information used in user join/leave notifications
|
|
1174
1306
|
|
|
1175
|
-
|
|
1307
|
+
DESCRIPTION
|
|
1308
|
+
Subscribes to realtime notifications
|
|
1176
1309
|
|
|
1177
|
-
|
|
1310
|
+
EXAMPLES
|
|
1311
|
+
$ kourou realtime:subscribe iot-data sensors
|
|
1178
1312
|
|
|
1179
|
-
|
|
1313
|
+
$ kourou realtime:subscribe iot-data sensors '{ range: { temperature: { gt: 0 } } }'
|
|
1180
1314
|
|
|
1181
|
-
|
|
1315
|
+
$ kourou realtime:subscribe iot-data sensors '{ exists: "position" }' --scope out
|
|
1182
1316
|
|
|
1183
|
-
|
|
1317
|
+
$ kourou realtime:subscribe iot-data sensors --users all --volatile '{ clientId: "citizen-kane" }'
|
|
1184
1318
|
|
|
1185
|
-
|
|
1186
|
-
kourou realtime:subscribe iot-data sensors
|
|
1187
|
-
kourou realtime:subscribe iot-data sensors '{ range: { temperature: { gt: 0 } } }'
|
|
1188
|
-
kourou realtime:subscribe iot-data sensors '{ exists: "position" }' --scope out
|
|
1189
|
-
kourou realtime:subscribe iot-data sensors --users all --volatile '{ clientId: "citizen-kane" }'
|
|
1190
|
-
kourou realtime:subscribe iot-data sensors --display result._source.temperature
|
|
1319
|
+
$ kourou realtime:subscribe iot-data sensors --display result._source.temperature
|
|
1191
1320
|
```
|
|
1192
1321
|
|
|
1193
|
-
_See code: [
|
|
1322
|
+
_See code: [src/commands/realtime/subscribe.ts](src/commands/realtime/subscribe.ts)_
|
|
1194
1323
|
|
|
1195
1324
|
## `kourou redis:list-keys [MATCH]`
|
|
1196
1325
|
|
|
@@ -1198,31 +1327,36 @@ Lists keys stored in Redis
|
|
|
1198
1327
|
|
|
1199
1328
|
```
|
|
1200
1329
|
USAGE
|
|
1201
|
-
$ kourou redis:list-keys [MATCH]
|
|
1330
|
+
$ kourou redis:list-keys [MATCH] [--help] [--remove] [--size <value>] [--max <value>] [--host <value>] [--port
|
|
1331
|
+
<value>] [--ssl] [--username <value>] [--password <value>] [--protocol <value>] [--as <value>] [--api-key <value>]
|
|
1202
1332
|
|
|
1203
1333
|
ARGUMENTS
|
|
1204
|
-
MATCH [default: *] Match Redis keys with a pattern
|
|
1205
|
-
|
|
1206
|
-
|
|
1207
|
-
--api-key
|
|
1208
|
-
--as
|
|
1209
|
-
--help
|
|
1210
|
-
--host
|
|
1211
|
-
--max
|
|
1212
|
-
--password
|
|
1213
|
-
--port
|
|
1214
|
-
--protocol
|
|
1215
|
-
--remove
|
|
1216
|
-
--size
|
|
1217
|
-
--ssl
|
|
1218
|
-
--username
|
|
1334
|
+
[MATCH] [default: *] Match Redis keys with a pattern
|
|
1335
|
+
|
|
1336
|
+
FLAGS
|
|
1337
|
+
--api-key=<value> Kuzzle user api-key
|
|
1338
|
+
--as=<value> Impersonate a user
|
|
1339
|
+
--help Show CLI help.
|
|
1340
|
+
--host=<value> [default: localhost] Kuzzle server host
|
|
1341
|
+
--max=<value> [default: -1] Maximum number of page to retrieve (-1 to retrieve everything)
|
|
1342
|
+
--password=<value> Kuzzle user password
|
|
1343
|
+
--port=<value> [default: 7512] Kuzzle server port
|
|
1344
|
+
--protocol=<value> [default: ws] Kuzzle protocol (http or ws)
|
|
1345
|
+
--remove Remove matching keys
|
|
1346
|
+
--size=<value> [default: 100] Page size
|
|
1347
|
+
--ssl Use SSL to connect to Kuzzle
|
|
1348
|
+
--username=<value> [default: anonymous] Kuzzle username (local strategy)
|
|
1349
|
+
|
|
1350
|
+
DESCRIPTION
|
|
1351
|
+
Lists keys stored in Redis
|
|
1219
1352
|
|
|
1220
1353
|
EXAMPLES
|
|
1221
|
-
kourou redis:list-keys "*cluster*"
|
|
1222
|
-
|
|
1354
|
+
$ kourou redis:list-keys "*cluster*"
|
|
1355
|
+
|
|
1356
|
+
$ kourou redis:list-keys "counters/*" --remove
|
|
1223
1357
|
```
|
|
1224
1358
|
|
|
1225
|
-
_See code: [
|
|
1359
|
+
_See code: [src/commands/redis/list-keys.ts](src/commands/redis/list-keys.ts)_
|
|
1226
1360
|
|
|
1227
1361
|
## `kourou role:export`
|
|
1228
1362
|
|
|
@@ -1230,22 +1364,26 @@ Exports roles
|
|
|
1230
1364
|
|
|
1231
1365
|
```
|
|
1232
1366
|
USAGE
|
|
1233
|
-
$ kourou role:export
|
|
1367
|
+
$ kourou role:export [--help] [--path <value>] [--host <value>] [--port <value>] [--ssl] [--username <value>]
|
|
1368
|
+
[--password <value>] [--protocol <value>] [--as <value>] [--api-key <value>]
|
|
1369
|
+
|
|
1370
|
+
FLAGS
|
|
1371
|
+
--api-key=<value> Kuzzle user api-key
|
|
1372
|
+
--as=<value> Impersonate a user
|
|
1373
|
+
--help Show CLI help.
|
|
1374
|
+
--host=<value> [default: localhost] Kuzzle server host
|
|
1375
|
+
--password=<value> Kuzzle user password
|
|
1376
|
+
--path=<value> [default: roles] Dump directory
|
|
1377
|
+
--port=<value> [default: 7512] Kuzzle server port
|
|
1378
|
+
--protocol=<value> [default: ws] Kuzzle protocol (http or websocket)
|
|
1379
|
+
--ssl Use SSL to connect to Kuzzle
|
|
1380
|
+
--username=<value> [default: anonymous] Kuzzle username (local strategy)
|
|
1234
1381
|
|
|
1235
|
-
|
|
1236
|
-
|
|
1237
|
-
--as=as Impersonate a user
|
|
1238
|
-
--help show CLI help
|
|
1239
|
-
--host=host [default: localhost] Kuzzle server host
|
|
1240
|
-
--password=password Kuzzle user password
|
|
1241
|
-
--path=path [default: roles] Dump directory
|
|
1242
|
-
--port=port [default: 7512] Kuzzle server port
|
|
1243
|
-
--protocol=protocol [default: ws] Kuzzle protocol (http or websocket)
|
|
1244
|
-
--ssl Use SSL to connect to Kuzzle
|
|
1245
|
-
--username=username [default: anonymous] Kuzzle username (local strategy)
|
|
1382
|
+
DESCRIPTION
|
|
1383
|
+
Exports roles
|
|
1246
1384
|
```
|
|
1247
1385
|
|
|
1248
|
-
_See code: [
|
|
1386
|
+
_See code: [src/commands/role/export.ts](src/commands/role/export.ts)_
|
|
1249
1387
|
|
|
1250
1388
|
## `kourou role:import PATH`
|
|
1251
1389
|
|
|
@@ -1253,25 +1391,29 @@ Import roles
|
|
|
1253
1391
|
|
|
1254
1392
|
```
|
|
1255
1393
|
USAGE
|
|
1256
|
-
$ kourou role:import PATH
|
|
1394
|
+
$ kourou role:import PATH [--preserve-anonymous] [--help] [--host <value>] [--port <value>] [--ssl] [--username
|
|
1395
|
+
<value>] [--password <value>] [--protocol <value>] [--as <value>] [--api-key <value>]
|
|
1257
1396
|
|
|
1258
1397
|
ARGUMENTS
|
|
1259
1398
|
PATH Dump file
|
|
1260
1399
|
|
|
1261
|
-
|
|
1262
|
-
--api-key
|
|
1263
|
-
--as
|
|
1264
|
-
--help
|
|
1265
|
-
--host
|
|
1266
|
-
--password
|
|
1267
|
-
--port
|
|
1400
|
+
FLAGS
|
|
1401
|
+
--api-key=<value> Kuzzle user api-key
|
|
1402
|
+
--as=<value> Impersonate a user
|
|
1403
|
+
--help Show CLI help.
|
|
1404
|
+
--host=<value> [default: localhost] Kuzzle server host
|
|
1405
|
+
--password=<value> Kuzzle user password
|
|
1406
|
+
--port=<value> [default: 7512] Kuzzle server port
|
|
1268
1407
|
--preserve-anonymous Preserve anonymous rights
|
|
1269
|
-
--protocol
|
|
1408
|
+
--protocol=<value> [default: ws] Kuzzle protocol (http or websocket)
|
|
1270
1409
|
--ssl Use SSL to connect to Kuzzle
|
|
1271
|
-
--username
|
|
1410
|
+
--username=<value> [default: anonymous] Kuzzle username (local strategy)
|
|
1411
|
+
|
|
1412
|
+
DESCRIPTION
|
|
1413
|
+
Import roles
|
|
1272
1414
|
```
|
|
1273
1415
|
|
|
1274
|
-
_See code: [
|
|
1416
|
+
_See code: [src/commands/role/import.ts](src/commands/role/import.ts)_
|
|
1275
1417
|
|
|
1276
1418
|
## `kourou sdk:execute [CODE]`
|
|
1277
1419
|
|
|
@@ -1279,57 +1421,60 @@ Executes arbitrary code.
|
|
|
1279
1421
|
|
|
1280
1422
|
```
|
|
1281
1423
|
USAGE
|
|
1282
|
-
$ kourou sdk:execute [CODE]
|
|
1424
|
+
$ kourou sdk:execute [CODE] [--help] [-v <value>...] [--editor] [--keep-alive] [--print-raw] [--host <value>]
|
|
1425
|
+
[--port <value>] [--ssl] [--username <value>] [--password <value>] [--protocol <value>] [--as <value>] [--api-key
|
|
1426
|
+
<value>]
|
|
1283
1427
|
|
|
1284
1428
|
ARGUMENTS
|
|
1285
|
-
CODE Code to execute. Will be read from STDIN if available.
|
|
1286
|
-
|
|
1287
|
-
|
|
1288
|
-
-v, --var
|
|
1289
|
-
|
|
1290
|
-
|
|
1291
|
-
|
|
1292
|
-
|
|
1293
|
-
|
|
1294
|
-
|
|
1295
|
-
|
|
1296
|
-
|
|
1297
|
-
|
|
1298
|
-
|
|
1299
|
-
|
|
1300
|
-
|
|
1429
|
+
[CODE] Code to execute. Will be read from STDIN if available.
|
|
1430
|
+
|
|
1431
|
+
FLAGS
|
|
1432
|
+
-v, --var=<value>... Additional arguments injected into the code. (eg: --var 'index="iot-data"'
|
|
1433
|
+
--api-key=<value> Kuzzle user api-key
|
|
1434
|
+
--as=<value> Impersonate a user
|
|
1435
|
+
--editor Open an editor (EDITOR env variable) to edit the code before executing it.
|
|
1436
|
+
--help Show CLI help.
|
|
1437
|
+
--host=<value> [default: localhost] Kuzzle server host
|
|
1438
|
+
--keep-alive Keep the connection running (websocket only)
|
|
1439
|
+
--password=<value> Kuzzle user password
|
|
1440
|
+
--port=<value> [default: 7512] Kuzzle server port
|
|
1441
|
+
--print-raw Print only the script result to stdout
|
|
1442
|
+
--protocol=<value> [default: ws] Kuzzle protocol (http or ws)
|
|
1443
|
+
--ssl Use SSL to connect to Kuzzle
|
|
1444
|
+
--username=<value> [default: anonymous] Kuzzle username (local strategy)
|
|
1301
1445
|
|
|
1302
1446
|
DESCRIPTION
|
|
1447
|
+
|
|
1303
1448
|
Executes arbitrary code.
|
|
1304
1449
|
|
|
1305
1450
|
Code Execution
|
|
1306
1451
|
|
|
1307
|
-
|
|
1308
|
-
|
|
1309
|
-
|
|
1310
|
-
|
|
1311
|
-
|
|
1452
|
+
Provided code will be executed in an async method.
|
|
1453
|
+
You can access a connected and authenticated SDK with the "sdk" variable.
|
|
1454
|
+
Templated variable passed as the command arguments are also accessible within the same name.
|
|
1455
|
+
Returned value will be printed on the standard output (e.g. 'return await sdk.server.now();').
|
|
1456
|
+
Errors will be caught and printed on the error output (e.g. 'throw new Error("failure");').
|
|
1312
1457
|
|
|
1313
1458
|
Provide code
|
|
1314
1459
|
|
|
1315
|
-
|
|
1316
|
-
|
|
1460
|
+
code can be passed as an argument
|
|
1461
|
+
code will be read from STDIN if available
|
|
1317
1462
|
|
|
1318
|
-
|
|
1319
|
-
|
|
1320
|
-
|
|
1321
|
-
|
|
1322
|
-
|
|
1463
|
+
Examples:
|
|
1464
|
+
- kourou sdk:execute 'return await sdk.server.now()'
|
|
1465
|
+
- kourou sdk:execute 'return await sdk.index.exists(index)' --var 'index="iot-data"'
|
|
1466
|
+
- kourou sdk:execute < snippet.js
|
|
1467
|
+
- echo 'return await sdk.server.now()' | kourou sdk:execute
|
|
1323
1468
|
|
|
1324
1469
|
Other
|
|
1325
1470
|
|
|
1326
|
-
|
|
1471
|
+
use the --editor flag to modify the code before executing it
|
|
1327
1472
|
|
|
1328
|
-
|
|
1329
|
-
|
|
1473
|
+
Examples:
|
|
1474
|
+
- kourou sdk:execute 'return await sdk.server.now()' --editor
|
|
1330
1475
|
```
|
|
1331
1476
|
|
|
1332
|
-
_See code: [
|
|
1477
|
+
_See code: [src/commands/sdk/execute.ts](src/commands/sdk/execute.ts)_
|
|
1333
1478
|
|
|
1334
1479
|
## `kourou sdk:query CONTROLLER:ACTION`
|
|
1335
1480
|
|
|
@@ -1337,100 +1482,92 @@ Executes an API query.
|
|
|
1337
1482
|
|
|
1338
1483
|
```
|
|
1339
1484
|
USAGE
|
|
1340
|
-
$ kourou sdk:query CONTROLLER:ACTION
|
|
1485
|
+
$ kourou sdk:query CONTROLLER:ACTION [--help] [-a <value>...] [--body <value>] [--editor] [--body-editor] [-i
|
|
1486
|
+
<value>] [-c <value>] [--id <value>] [--display <value>] [--print-raw] [--host <value>] [--port <value>] [--ssl]
|
|
1487
|
+
[--username <value>] [--password <value>] [--protocol <value>] [--as <value>] [--api-key <value>]
|
|
1341
1488
|
|
|
1342
1489
|
ARGUMENTS
|
|
1343
1490
|
CONTROLLER:ACTION Controller and action (eg: "server:now")
|
|
1344
1491
|
|
|
1345
|
-
|
|
1346
|
-
-a, --arg
|
|
1347
|
-
-c, --collection
|
|
1348
|
-
-i, --index
|
|
1349
|
-
|
|
1350
|
-
|
|
1351
|
-
|
|
1352
|
-
|
|
1353
|
-
|
|
1354
|
-
|
|
1355
|
-
|
|
1356
|
-
|
|
1357
|
-
|
|
1358
|
-
|
|
1359
|
-
|
|
1360
|
-
|
|
1361
|
-
|
|
1362
|
-
|
|
1363
|
-
|
|
1364
|
-
|
|
1365
|
-
--password=password Kuzzle user password
|
|
1366
|
-
|
|
1367
|
-
--port=port [default: 7512] Kuzzle server port
|
|
1368
|
-
|
|
1369
|
-
--print-raw Print only the query result to stdout
|
|
1370
|
-
|
|
1371
|
-
--protocol=protocol [default: ws] Kuzzle protocol (http or ws)
|
|
1372
|
-
|
|
1373
|
-
--ssl Use SSL to connect to Kuzzle
|
|
1374
|
-
|
|
1375
|
-
--username=username [default: anonymous] Kuzzle username (local strategy)
|
|
1492
|
+
FLAGS
|
|
1493
|
+
-a, --arg=<value>... Additional argument. Repeatable. (e.g. "-a refresh=wait_for")
|
|
1494
|
+
-c, --collection=<value> Collection argument
|
|
1495
|
+
-i, --index=<value> Index argument
|
|
1496
|
+
--api-key=<value> Kuzzle user api-key
|
|
1497
|
+
--as=<value> Impersonate a user
|
|
1498
|
+
--body=<value> [default: {}] Request body in JS or JSON format. Will be read from STDIN if available.
|
|
1499
|
+
--body-editor Open an editor (EDITOR env variable) to edit the body before sending.
|
|
1500
|
+
--display=<value> [default: result] Path of the property to display from the response (empty string to display
|
|
1501
|
+
the result)
|
|
1502
|
+
--editor Open an editor (EDITOR env variable) to edit the request before sending.
|
|
1503
|
+
--help Show CLI help.
|
|
1504
|
+
--host=<value> [default: localhost] Kuzzle server host
|
|
1505
|
+
--id=<value> ID argument (_id)
|
|
1506
|
+
--password=<value> Kuzzle user password
|
|
1507
|
+
--port=<value> [default: 7512] Kuzzle server port
|
|
1508
|
+
--print-raw Print only the query result to stdout
|
|
1509
|
+
--protocol=<value> [default: ws] Kuzzle protocol (http or ws)
|
|
1510
|
+
--ssl Use SSL to connect to Kuzzle
|
|
1511
|
+
--username=<value> [default: anonymous] Kuzzle username (local strategy)
|
|
1376
1512
|
|
|
1377
1513
|
DESCRIPTION
|
|
1514
|
+
|
|
1378
1515
|
Executes an API query.
|
|
1379
1516
|
|
|
1380
1517
|
Query arguments
|
|
1381
1518
|
|
|
1382
|
-
|
|
1383
|
-
|
|
1384
|
-
|
|
1519
|
+
Arguments can be passed and repeated using the --arg or -a flag.
|
|
1520
|
+
Index and collection names can be passed with --index (-i) and --collection (-c) flags
|
|
1521
|
+
ID can be passed with the --id flag.
|
|
1385
1522
|
|
|
1386
|
-
|
|
1387
|
-
|
|
1523
|
+
Examples:
|
|
1524
|
+
- kourou sdk:query document:delete -i iot -c sensors -a refresh=wait_for
|
|
1388
1525
|
|
|
1389
1526
|
Query body
|
|
1390
1527
|
|
|
1391
|
-
|
|
1392
|
-
|
|
1528
|
+
Body can be passed with the --body flag with either a JSON or JS string.
|
|
1529
|
+
Body will be read from STDIN if available
|
|
1393
1530
|
|
|
1394
|
-
|
|
1395
|
-
|
|
1396
|
-
|
|
1397
|
-
|
|
1531
|
+
Examples:
|
|
1532
|
+
- kourou sdk:query document:create -i iot -c sensors --body '{creation: Date.now())}'
|
|
1533
|
+
- kourou sdk:query admin:loadMappings < mappings.json
|
|
1534
|
+
- echo '{dynamic: "strict"}' | kourou sdk:query collection:create -i iot -c sensors
|
|
1398
1535
|
|
|
1399
1536
|
Other
|
|
1400
1537
|
|
|
1401
|
-
|
|
1402
|
-
|
|
1538
|
+
Use the --editor flag to modify the query before sending it to Kuzzle
|
|
1539
|
+
Use the --display flag to display a specific property of the response
|
|
1403
1540
|
|
|
1404
|
-
|
|
1405
|
-
|
|
1406
|
-
|
|
1541
|
+
Examples:
|
|
1542
|
+
- kourou sdk:query document:create -i iot -c sensors --editor
|
|
1543
|
+
- kourou sdk:query server:now --display 'result.now'
|
|
1407
1544
|
|
|
1408
1545
|
Default fallback to API action
|
|
1409
1546
|
|
|
1410
|
-
|
|
1411
|
-
|
|
1547
|
+
It's possible to use the "sdk:query" command by only specifying the corresponding controller
|
|
1548
|
+
and action as first argument.
|
|
1412
1549
|
|
|
1413
|
-
|
|
1414
|
-
|
|
1415
|
-
|
|
1416
|
-
|
|
1417
|
-
|
|
1418
|
-
|
|
1419
|
-
|
|
1550
|
+
Kourou will try to infer the first arguments to one the following pattern:
|
|
1551
|
+
- <command> <index>
|
|
1552
|
+
- <command> <body>
|
|
1553
|
+
- <command> <index> <collection>
|
|
1554
|
+
- <command> <index> <collection> <id>
|
|
1555
|
+
- <command> <index> <collection> <body>
|
|
1556
|
+
- <command> <index> <collection> <id> <body>
|
|
1420
1557
|
|
|
1421
|
-
|
|
1422
|
-
|
|
1558
|
+
If a flag is given (-i, -c, --body or --id), then the flag value has priority over
|
|
1559
|
+
argument infering.
|
|
1423
1560
|
|
|
1424
|
-
|
|
1425
|
-
|
|
1426
|
-
|
|
1427
|
-
|
|
1428
|
-
|
|
1429
|
-
|
|
1430
|
-
|
|
1561
|
+
Examples:
|
|
1562
|
+
- kourou collection:list iot
|
|
1563
|
+
- kourou security:createUser '{ "content": { "profileIds": ["default"] } }' --id yagmur
|
|
1564
|
+
- kourou collection:delete iot sensors
|
|
1565
|
+
- kourou document:createOrReplace iot sensors sigfox-1 '{}'
|
|
1566
|
+
- kourou bulk:import iot sensors '{ bulkData: [...] }'
|
|
1567
|
+
- kourou admin:loadMappings < mappings.json
|
|
1431
1568
|
```
|
|
1432
1569
|
|
|
1433
|
-
_See code: [
|
|
1570
|
+
_See code: [src/commands/sdk/query.ts](src/commands/sdk/query.ts)_
|
|
1434
1571
|
|
|
1435
1572
|
## `kourou user:export`
|
|
1436
1573
|
|
|
@@ -1438,51 +1575,54 @@ Exports users to JSON.
|
|
|
1438
1575
|
|
|
1439
1576
|
```
|
|
1440
1577
|
USAGE
|
|
1441
|
-
$ kourou user:export
|
|
1442
|
-
|
|
1443
|
-
|
|
1444
|
-
|
|
1445
|
-
|
|
1446
|
-
--
|
|
1447
|
-
--
|
|
1448
|
-
--
|
|
1449
|
-
--
|
|
1450
|
-
--
|
|
1451
|
-
--
|
|
1452
|
-
--
|
|
1453
|
-
--
|
|
1454
|
-
--
|
|
1455
|
-
--
|
|
1456
|
-
--
|
|
1457
|
-
--
|
|
1578
|
+
$ kourou user:export [--help] [--path <value>] [--exclude <value>...] [--generate-credentials]
|
|
1579
|
+
[--generated-username <value>] [--batch-size <value>] [--host <value>] [--port <value>] [--ssl] [--username <value>]
|
|
1580
|
+
[--password <value>] [--protocol <value>] [--as <value>] [--api-key <value>]
|
|
1581
|
+
|
|
1582
|
+
FLAGS
|
|
1583
|
+
--api-key=<value> Kuzzle user api-key
|
|
1584
|
+
--as=<value> Impersonate a user
|
|
1585
|
+
--batch-size=<value> [default: 2000] Maximum batch size (see limits.documentsFetchCount config)
|
|
1586
|
+
--exclude=<value>... Exclude users by matching their IDs with a regexp
|
|
1587
|
+
--generate-credentials Generate credentials with a random password for users
|
|
1588
|
+
--generated-username=<value> [default: _id] User content property used as a username for local credentials
|
|
1589
|
+
--help Show CLI help.
|
|
1590
|
+
--host=<value> [default: localhost] Kuzzle server host
|
|
1591
|
+
--password=<value> Kuzzle user password
|
|
1592
|
+
--path=<value> [default: users] Dump directory
|
|
1593
|
+
--port=<value> [default: 7512] Kuzzle server port
|
|
1594
|
+
--protocol=<value> [default: ws] Kuzzle protocol (http or websocket)
|
|
1595
|
+
--ssl Use SSL to connect to Kuzzle
|
|
1596
|
+
--username=<value> [default: anonymous] Kuzzle username (local strategy)
|
|
1458
1597
|
|
|
1459
1598
|
DESCRIPTION
|
|
1599
|
+
|
|
1460
1600
|
Exports users to JSON.
|
|
1461
1601
|
|
|
1462
1602
|
The users will be exported WITHOUT their credentials since Kuzzzle can't access them.
|
|
1463
1603
|
|
|
1464
1604
|
You can either:
|
|
1465
|
-
|
|
1466
|
-
|
|
1605
|
+
- Manually re-create credentials for your users
|
|
1606
|
+
- Use the "mustChangePasswordIfSetByAdmin" option Kuzzle password policies (see
|
|
1467
1607
|
https://github.com/kuzzleio/kuzzle-plugin-auth-passport-local/#optional-properties)
|
|
1468
|
-
|
|
1608
|
+
- Use the "--generate-credentials" flag to auto-generate credentials for your users
|
|
1469
1609
|
|
|
1470
1610
|
Auto-generation of credentials
|
|
1471
1611
|
|
|
1472
|
-
|
|
1473
|
-
|
|
1474
|
-
|
|
1475
|
-
|
|
1612
|
+
With the "--generate-credentials" flag, Kourou will add credentials for the "local" strategy.
|
|
1613
|
+
By default, the username will be the user ID.
|
|
1614
|
+
Use the "generated-username" flag to use an other property than the user ID for the generated username
|
|
1615
|
+
The password will be a strong random 40 characters string
|
|
1476
1616
|
|
|
1477
1617
|
Examples:
|
|
1478
1618
|
|
|
1479
|
-
|
|
1480
|
-
|
|
1481
|
-
|
|
1482
|
-
|
|
1619
|
+
- kourou user:export
|
|
1620
|
+
- kourou user:export --exclude '.*admin.*' --exclude 'supervisor.*'
|
|
1621
|
+
- kourou user:export --generate-credentials
|
|
1622
|
+
- kourou user:export --generate-credentials --generated-username content.email
|
|
1483
1623
|
```
|
|
1484
1624
|
|
|
1485
|
-
_See code: [
|
|
1625
|
+
_See code: [src/commands/user/export.ts](src/commands/user/export.ts)_
|
|
1486
1626
|
|
|
1487
1627
|
## `kourou user:export-mappings`
|
|
1488
1628
|
|
|
@@ -1490,22 +1630,26 @@ Exports users collection mappings to JSON.
|
|
|
1490
1630
|
|
|
1491
1631
|
```
|
|
1492
1632
|
USAGE
|
|
1493
|
-
$ kourou user:export-mappings
|
|
1633
|
+
$ kourou user:export-mappings [--help] [--path <value>] [--host <value>] [--port <value>] [--ssl] [--username <value>]
|
|
1634
|
+
[--password <value>] [--protocol <value>] [--as <value>] [--api-key <value>]
|
|
1635
|
+
|
|
1636
|
+
FLAGS
|
|
1637
|
+
--api-key=<value> Kuzzle user api-key
|
|
1638
|
+
--as=<value> Impersonate a user
|
|
1639
|
+
--help Show CLI help.
|
|
1640
|
+
--host=<value> [default: localhost] Kuzzle server host
|
|
1641
|
+
--password=<value> Kuzzle user password
|
|
1642
|
+
--path=<value> [default: users] Dump directory
|
|
1643
|
+
--port=<value> [default: 7512] Kuzzle server port
|
|
1644
|
+
--protocol=<value> [default: ws] Kuzzle protocol (http or websocket)
|
|
1645
|
+
--ssl Use SSL to connect to Kuzzle
|
|
1646
|
+
--username=<value> [default: anonymous] Kuzzle username (local strategy)
|
|
1494
1647
|
|
|
1495
|
-
|
|
1496
|
-
|
|
1497
|
-
--as=as Impersonate a user
|
|
1498
|
-
--help show CLI help
|
|
1499
|
-
--host=host [default: localhost] Kuzzle server host
|
|
1500
|
-
--password=password Kuzzle user password
|
|
1501
|
-
--path=path [default: users] Dump directory
|
|
1502
|
-
--port=port [default: 7512] Kuzzle server port
|
|
1503
|
-
--protocol=protocol [default: ws] Kuzzle protocol (http or websocket)
|
|
1504
|
-
--ssl Use SSL to connect to Kuzzle
|
|
1505
|
-
--username=username [default: anonymous] Kuzzle username (local strategy)
|
|
1648
|
+
DESCRIPTION
|
|
1649
|
+
Exports users collection mappings to JSON.
|
|
1506
1650
|
```
|
|
1507
1651
|
|
|
1508
|
-
_See code: [
|
|
1652
|
+
_See code: [src/commands/user/export-mappings.ts](src/commands/user/export-mappings.ts)_
|
|
1509
1653
|
|
|
1510
1654
|
## `kourou user:import PATH`
|
|
1511
1655
|
|
|
@@ -1513,24 +1657,28 @@ Imports users
|
|
|
1513
1657
|
|
|
1514
1658
|
```
|
|
1515
1659
|
USAGE
|
|
1516
|
-
$ kourou user:import PATH
|
|
1660
|
+
$ kourou user:import PATH [--help] [--host <value>] [--port <value>] [--ssl] [--username <value>] [--password
|
|
1661
|
+
<value>] [--protocol <value>] [--as <value>] [--api-key <value>]
|
|
1517
1662
|
|
|
1518
1663
|
ARGUMENTS
|
|
1519
1664
|
PATH Dump file
|
|
1520
1665
|
|
|
1521
|
-
|
|
1522
|
-
--api-key
|
|
1523
|
-
--as
|
|
1524
|
-
--help
|
|
1525
|
-
--host
|
|
1526
|
-
--password
|
|
1527
|
-
--port
|
|
1528
|
-
--protocol
|
|
1529
|
-
--ssl
|
|
1530
|
-
--username
|
|
1666
|
+
FLAGS
|
|
1667
|
+
--api-key=<value> Kuzzle user api-key
|
|
1668
|
+
--as=<value> Impersonate a user
|
|
1669
|
+
--help Show CLI help.
|
|
1670
|
+
--host=<value> [default: localhost] Kuzzle server host
|
|
1671
|
+
--password=<value> Kuzzle user password
|
|
1672
|
+
--port=<value> [default: 7512] Kuzzle server port
|
|
1673
|
+
--protocol=<value> [default: ws] Kuzzle protocol (http or websocket)
|
|
1674
|
+
--ssl Use SSL to connect to Kuzzle
|
|
1675
|
+
--username=<value> [default: anonymous] Kuzzle username (local strategy)
|
|
1676
|
+
|
|
1677
|
+
DESCRIPTION
|
|
1678
|
+
Imports users
|
|
1531
1679
|
```
|
|
1532
1680
|
|
|
1533
|
-
_See code: [
|
|
1681
|
+
_See code: [src/commands/user/import.ts](src/commands/user/import.ts)_
|
|
1534
1682
|
|
|
1535
1683
|
## `kourou user:import-mappings PATH`
|
|
1536
1684
|
|
|
@@ -1538,24 +1686,28 @@ Imports users collection mappings
|
|
|
1538
1686
|
|
|
1539
1687
|
```
|
|
1540
1688
|
USAGE
|
|
1541
|
-
$ kourou user:import-mappings PATH
|
|
1689
|
+
$ kourou user:import-mappings PATH [--help] [--host <value>] [--port <value>] [--ssl] [--username <value>] [--password
|
|
1690
|
+
<value>] [--protocol <value>] [--as <value>] [--api-key <value>]
|
|
1542
1691
|
|
|
1543
1692
|
ARGUMENTS
|
|
1544
1693
|
PATH Dump file
|
|
1545
1694
|
|
|
1546
|
-
|
|
1547
|
-
--api-key
|
|
1548
|
-
--as
|
|
1549
|
-
--help
|
|
1550
|
-
--host
|
|
1551
|
-
--password
|
|
1552
|
-
--port
|
|
1553
|
-
--protocol
|
|
1554
|
-
--ssl
|
|
1555
|
-
--username
|
|
1695
|
+
FLAGS
|
|
1696
|
+
--api-key=<value> Kuzzle user api-key
|
|
1697
|
+
--as=<value> Impersonate a user
|
|
1698
|
+
--help Show CLI help.
|
|
1699
|
+
--host=<value> [default: localhost] Kuzzle server host
|
|
1700
|
+
--password=<value> Kuzzle user password
|
|
1701
|
+
--port=<value> [default: 7512] Kuzzle server port
|
|
1702
|
+
--protocol=<value> [default: ws] Kuzzle protocol (http or websocket)
|
|
1703
|
+
--ssl Use SSL to connect to Kuzzle
|
|
1704
|
+
--username=<value> [default: anonymous] Kuzzle username (local strategy)
|
|
1705
|
+
|
|
1706
|
+
DESCRIPTION
|
|
1707
|
+
Imports users collection mappings
|
|
1556
1708
|
```
|
|
1557
1709
|
|
|
1558
|
-
_See code: [
|
|
1710
|
+
_See code: [src/commands/user/import-mappings.ts](src/commands/user/import-mappings.ts)_
|
|
1559
1711
|
|
|
1560
1712
|
## `kourou vault:add SECRETS-FILE KEY VALUE`
|
|
1561
1713
|
|
|
@@ -1563,17 +1715,18 @@ Adds an encrypted key to an encrypted secrets file.
|
|
|
1563
1715
|
|
|
1564
1716
|
```
|
|
1565
1717
|
USAGE
|
|
1566
|
-
$ kourou vault:add SECRETS-FILE KEY VALUE
|
|
1718
|
+
$ kourou vault:add SECRETS-FILE KEY VALUE [--vault-key <value>]
|
|
1567
1719
|
|
|
1568
1720
|
ARGUMENTS
|
|
1569
1721
|
SECRETS-FILE Encrypted secrets file
|
|
1570
1722
|
KEY Path to the key (lodash style)
|
|
1571
1723
|
VALUE Value to encrypt
|
|
1572
1724
|
|
|
1573
|
-
|
|
1574
|
-
--vault-key
|
|
1725
|
+
FLAGS
|
|
1726
|
+
--vault-key=<value> Kuzzle Vault Key (or KUZZLE_VAULT_KEY)
|
|
1575
1727
|
|
|
1576
1728
|
DESCRIPTION
|
|
1729
|
+
|
|
1577
1730
|
Adds an encrypted key to an encrypted secrets file.
|
|
1578
1731
|
|
|
1579
1732
|
A new secrets file is created if it does not yet exist.
|
|
@@ -1582,11 +1735,12 @@ DESCRIPTION
|
|
|
1582
1735
|
|
|
1583
1736
|
See https://github.com/kuzzleio/kuzzle-vault/ for more information.
|
|
1584
1737
|
|
|
1585
|
-
|
|
1586
|
-
|
|
1738
|
+
|
|
1739
|
+
EXAMPLES
|
|
1740
|
+
$ kourou vault:add config/secrets.enc.json aws.s3.keyId b61e267676660c314b006b06 --vault-key <vault-key>
|
|
1587
1741
|
```
|
|
1588
1742
|
|
|
1589
|
-
_See code: [
|
|
1743
|
+
_See code: [src/commands/vault/add.ts](src/commands/vault/add.ts)_
|
|
1590
1744
|
|
|
1591
1745
|
## `kourou vault:decrypt FILE`
|
|
1592
1746
|
|
|
@@ -1594,29 +1748,32 @@ Decrypts an entire secrets file.
|
|
|
1594
1748
|
|
|
1595
1749
|
```
|
|
1596
1750
|
USAGE
|
|
1597
|
-
$ kourou vault:decrypt FILE
|
|
1751
|
+
$ kourou vault:decrypt FILE [-f] [-o <value>] [--vault-key <value>]
|
|
1598
1752
|
|
|
1599
1753
|
ARGUMENTS
|
|
1600
1754
|
FILE File containing encrypted secrets
|
|
1601
1755
|
|
|
1602
|
-
|
|
1603
|
-
-f, --force
|
|
1604
|
-
-o, --output-file
|
|
1605
|
-
|
|
1756
|
+
FLAGS
|
|
1757
|
+
-f, --force Overwrite the output file if it already exists
|
|
1758
|
+
-o, --output-file=<value> Output file (default: remove ".enc")
|
|
1759
|
+
--vault-key=<value> Kuzzle Vault Key (or KUZZLE_VAULT_KEY)
|
|
1606
1760
|
|
|
1607
1761
|
DESCRIPTION
|
|
1762
|
+
|
|
1608
1763
|
Decrypts an entire secrets file.
|
|
1609
1764
|
|
|
1610
1765
|
Decrypted secrets file must NEVER be committed into the repository.
|
|
1611
1766
|
|
|
1612
1767
|
See https://github.com/kuzzleio/kuzzle-vault/ for more information.
|
|
1613
1768
|
|
|
1769
|
+
|
|
1614
1770
|
EXAMPLES
|
|
1615
|
-
kourou vault:decrypt config/secrets.enc.json --vault-key <vault-key>
|
|
1616
|
-
|
|
1771
|
+
$ kourou vault:decrypt config/secrets.enc.json --vault-key <vault-key>
|
|
1772
|
+
|
|
1773
|
+
$ kourou vault:decrypt config/secrets.enc.json -o config/secrets.json --vault-key <vault-key>
|
|
1617
1774
|
```
|
|
1618
1775
|
|
|
1619
|
-
_See code: [
|
|
1776
|
+
_See code: [src/commands/vault/decrypt.ts](src/commands/vault/decrypt.ts)_
|
|
1620
1777
|
|
|
1621
1778
|
## `kourou vault:encrypt FILE`
|
|
1622
1779
|
|
|
@@ -1624,40 +1781,43 @@ Encrypts an entire secrets file.
|
|
|
1624
1781
|
|
|
1625
1782
|
```
|
|
1626
1783
|
USAGE
|
|
1627
|
-
$ kourou vault:encrypt FILE
|
|
1784
|
+
$ kourou vault:encrypt FILE [-f] [-o <value>] [--vault-key <value>]
|
|
1628
1785
|
|
|
1629
1786
|
ARGUMENTS
|
|
1630
1787
|
FILE File containing unencrypted secrets
|
|
1631
1788
|
|
|
1632
|
-
|
|
1633
|
-
-f, --force
|
|
1634
|
-
-o, --output-file
|
|
1635
|
-
|
|
1789
|
+
FLAGS
|
|
1790
|
+
-f, --force Overwrite the output file if it already exists
|
|
1791
|
+
-o, --output-file=<value> Output file (default: <file>.enc.json)
|
|
1792
|
+
--vault-key=<value> Kuzzle Vault Key (or KUZZLE_VAULT_KEY)
|
|
1636
1793
|
|
|
1637
1794
|
DESCRIPTION
|
|
1795
|
+
|
|
1638
1796
|
Encrypts an entire secrets file.
|
|
1639
1797
|
|
|
1640
1798
|
The secrets file must be in JSON format and it must contain only strings or objects.
|
|
1641
1799
|
|
|
1642
1800
|
Example:
|
|
1643
1801
|
{
|
|
1644
|
-
|
|
1645
|
-
|
|
1646
|
-
|
|
1647
|
-
|
|
1648
|
-
|
|
1802
|
+
aws: {
|
|
1803
|
+
s3: {
|
|
1804
|
+
keyId: 'b61e267676660c314b006b06'
|
|
1805
|
+
}
|
|
1806
|
+
}
|
|
1649
1807
|
}
|
|
1650
1808
|
|
|
1651
1809
|
Encrypted secrets are meant to be loaded inside an application with Kuzzle Vault.
|
|
1652
1810
|
|
|
1653
1811
|
See https://github.com/kuzzleio/kuzzle-vault/ for more information.
|
|
1654
1812
|
|
|
1813
|
+
|
|
1655
1814
|
EXAMPLES
|
|
1656
|
-
kourou vault:encrypt config/secrets.json --vault-key <vault-key>
|
|
1657
|
-
|
|
1815
|
+
$ kourou vault:encrypt config/secrets.json --vault-key <vault-key>
|
|
1816
|
+
|
|
1817
|
+
$ kourou vault:encrypt config/secrets.json -o config/secrets_prod.enc.json --vault-key <vault-key>
|
|
1658
1818
|
```
|
|
1659
1819
|
|
|
1660
|
-
_See code: [
|
|
1820
|
+
_See code: [src/commands/vault/encrypt.ts](src/commands/vault/encrypt.ts)_
|
|
1661
1821
|
|
|
1662
1822
|
## `kourou vault:show SECRETS-FILE [KEY]`
|
|
1663
1823
|
|
|
@@ -1665,30 +1825,33 @@ Prints an encrypted secrets file content.
|
|
|
1665
1825
|
|
|
1666
1826
|
```
|
|
1667
1827
|
USAGE
|
|
1668
|
-
$ kourou vault:show SECRETS-FILE [KEY]
|
|
1828
|
+
$ kourou vault:show SECRETS-FILE [KEY] [--vault-key <value>]
|
|
1669
1829
|
|
|
1670
1830
|
ARGUMENTS
|
|
1671
1831
|
SECRETS-FILE Encrypted secrets file
|
|
1672
|
-
KEY
|
|
1832
|
+
[KEY] Path to a key (lodash style)
|
|
1673
1833
|
|
|
1674
|
-
|
|
1675
|
-
--vault-key
|
|
1834
|
+
FLAGS
|
|
1835
|
+
--vault-key=<value> Kuzzle Vault Key (or KUZZLE_VAULT_KEY)
|
|
1676
1836
|
|
|
1677
1837
|
DESCRIPTION
|
|
1838
|
+
|
|
1678
1839
|
Prints an encrypted secrets file content.
|
|
1679
1840
|
|
|
1680
1841
|
This method can display either:
|
|
1681
|
-
|
|
1682
|
-
|
|
1842
|
+
- the entire content of the secrets file
|
|
1843
|
+
- a single key value
|
|
1683
1844
|
|
|
1684
1845
|
See https://github.com/kuzzleio/kuzzle-vault/ for more information.
|
|
1685
1846
|
|
|
1847
|
+
|
|
1686
1848
|
EXAMPLES
|
|
1687
|
-
kourou vault:show config/secrets.enc.json --vault-key <vault-key>
|
|
1688
|
-
|
|
1849
|
+
$ kourou vault:show config/secrets.enc.json --vault-key <vault-key>
|
|
1850
|
+
|
|
1851
|
+
$ kourou vault:show config/secrets.enc.json aws.s3.secretKey --vault-key <vault-key>
|
|
1689
1852
|
```
|
|
1690
1853
|
|
|
1691
|
-
_See code: [
|
|
1854
|
+
_See code: [src/commands/vault/show.ts](src/commands/vault/show.ts)_
|
|
1692
1855
|
|
|
1693
1856
|
## `kourou vault:test SECRETS-FILE`
|
|
1694
1857
|
|
|
@@ -1696,24 +1859,46 @@ Tests if an encrypted secrets file can be decrypted.
|
|
|
1696
1859
|
|
|
1697
1860
|
```
|
|
1698
1861
|
USAGE
|
|
1699
|
-
$ kourou vault:test SECRETS-FILE
|
|
1862
|
+
$ kourou vault:test SECRETS-FILE [--vault-key <value>]
|
|
1700
1863
|
|
|
1701
1864
|
ARGUMENTS
|
|
1702
1865
|
SECRETS-FILE Encrypted secrets file
|
|
1703
1866
|
|
|
1704
|
-
|
|
1705
|
-
--vault-key
|
|
1867
|
+
FLAGS
|
|
1868
|
+
--vault-key=<value> Kuzzle Vault Key (or KUZZLE_VAULT_KEY)
|
|
1706
1869
|
|
|
1707
1870
|
DESCRIPTION
|
|
1871
|
+
|
|
1708
1872
|
Tests if an encrypted secrets file can be decrypted.
|
|
1709
1873
|
|
|
1710
1874
|
See https://github.com/kuzzleio/kuzzle-vault/ for more information.
|
|
1711
1875
|
|
|
1712
|
-
|
|
1713
|
-
|
|
1876
|
+
|
|
1877
|
+
EXAMPLES
|
|
1878
|
+
$ kourou vault:test config/secrets.enc.json --vault-key <vault-key>
|
|
1879
|
+
```
|
|
1880
|
+
|
|
1881
|
+
_See code: [src/commands/vault/test.ts](src/commands/vault/test.ts)_
|
|
1882
|
+
|
|
1883
|
+
## `kourou version`
|
|
1884
|
+
|
|
1885
|
+
```
|
|
1886
|
+
USAGE
|
|
1887
|
+
$ kourou version [--json] [--verbose]
|
|
1888
|
+
|
|
1889
|
+
FLAGS
|
|
1890
|
+
--verbose Show additional information about the CLI.
|
|
1891
|
+
|
|
1892
|
+
GLOBAL FLAGS
|
|
1893
|
+
--json Format output as json.
|
|
1894
|
+
|
|
1895
|
+
FLAG DESCRIPTIONS
|
|
1896
|
+
--verbose Show additional information about the CLI.
|
|
1897
|
+
|
|
1898
|
+
Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.
|
|
1714
1899
|
```
|
|
1715
1900
|
|
|
1716
|
-
_See code: [
|
|
1901
|
+
_See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/3.0.0/src/commands/version.ts)_
|
|
1717
1902
|
<!-- commandsstop -->
|
|
1718
1903
|
|
|
1719
1904
|
# Where does this weird name come from?
|