kourou 0.19.4 → 0.19.5

package/README.md

@@ -25,7 +25,7 @@ $ npm install -g kourou
 $ kourou COMMAND
 running command...
 $ kourou (-v|--version|version)
-kourou/0.19.4 linux-x64 node-v12.22.7
+kourou/0.19.5 linux-x64 node-v12.22.8
 $ kourou --help [COMMAND]
 USAGE
   $ kourou COMMAND
@@ -143,7 +143,6 @@ All other arguments and options will be passed as-is to the `sdk:query` method.
 * [`kourou es:snapshot:create REPOSITORY NAME`](#kourou-essnapshotcreate-repository-name)
 * [`kourou es:snapshot:create-repository REPOSITORY LOCATION`](#kourou-essnapshotcreate-repository-repository-location)
 * [`kourou es:snapshot:list REPOSITORY`](#kourou-essnapshotlist-repository)
-* [`kourou es:snapshot:restore REPOSITORY NAME`](#kourou-essnapshotrestore-repository-name)
 * [`kourou file:decrypt FILE`](#kourou-filedecrypt-file)
 * [`kourou file:encrypt FILE`](#kourou-fileencrypt-file)
 * [`kourou file:test FILE`](#kourou-filetest-file)
@@ -379,31 +378,58 @@ ARGUMENTS
   COLLECTION  Collection name
 
 OPTIONS
-  --api-key=api-key        Kuzzle user api-key
-  --as=as                  Impersonate a user
-  --batch-size=batch-size  [default: 2000] Maximum batch size (see limits.documentsFetchCount config)
-  --editor                 Open an editor (EDITOR env variable) to edit the query before sending
+  --api-key=api-key
+      Kuzzle user api-key
 
-  --format=format          [default: JSONL] "jsonl or kuzzle - kuzzle will export in Kuzzle format usable for internal
-                           fixtures and jsonl allows to import that data back with kourou
+  --as=as
+      Impersonate a user
 
-  --help                   show CLI help
+  --batch-size=batch-size
+      [default: 2000] Maximum batch size (see limits.documentsFetchCount config)
 
-  --host=host              [default: localhost] Kuzzle server host
+  --editor
+      Open an editor (EDITOR env variable) to edit the query before sending
 
-  --password=password      Kuzzle user password
+  --fields=fields
+      [CSV format only] The list of fields to be included in the CSV export in dot-path format.
 
-  --path=path              Dump root directory
+      Example:
+      --fields oneField,anotherField,yetAnotherOne.nested.moarNested
 
-  --port=port              [default: 7512] Kuzzle server port
+      Note that the '_id' field is always included in the CSV export. Leaving this option empty implies that all
+      exportable fields in the mapping will be exported.
 
-  --protocol=protocol      [default: ws] Kuzzle protocol (http or websocket)
+  --format=jsonl|kuzzle|csv
+      [default: jsonl] "kuzzle" will export in Kuzzle format usable for internal fixtures,
+      "jsonl" allows to import that data back with kourou,
+      "csv" allows to import data into Excel (please, specify the fields to export using the --fields option).
 
-  --query=query            [default: {}] Only dump documents matching the query (JS or JSON format)
+  --help
+      show CLI help
 
-  --ssl                    Use SSL to connect to Kuzzle
+  --host=host
+      [default: localhost] Kuzzle server host
 
-  --username=username      [default: anonymous] Kuzzle username (local strategy)
+  --password=password
+      Kuzzle user password
+
+  --path=path
+      Dump root directory
+
+  --port=port
+      [default: 7512] Kuzzle server port
+
+  --protocol=protocol
+      [default: ws] Kuzzle protocol (http or websocket)
+
+  --query=query
+      [default: {}] Only dump documents matching the query (JS or JSON format)
+
+  --ssl
+      Use SSL to connect to Kuzzle
+
+  --username=username
+      [default: anonymous] Kuzzle username (local strategy)
 
 EXAMPLES
   kourou collection:export nyc-open-data yellow-taxi
@@ -637,25 +663,6 @@ OPTIONS
 
 _See code: [src/commands/es/snapshot/list.ts](src/commands/es/snapshot/list.ts)_
 
-## `kourou es:snapshot:restore REPOSITORY NAME`
-
-Restore a snapshot into an ES instance
-
-```
-USAGE
-  $ kourou es:snapshot:restore REPOSITORY NAME
-
-ARGUMENTS
-  REPOSITORY  ES repository name
-  NAME        ES snapshot name
-
-OPTIONS
-  -n, --node=node  [default: http://localhost:9200] Elasticsearch server URL
-  --help           show CLI help
-```
-
-_See code: [src/commands/es/snapshot/restore.ts](src/commands/es/snapshot/restore.ts)_
-
 ## `kourou file:decrypt FILE`
 
 Decrypts an encrypted file.
@@ -737,7 +744,7 @@ OPTIONS
   --all  see all commands in CLI
 ```
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.3/src/commands/help.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.2/src/commands/help.ts)_
 
 ## `kourou import PATH`
 
@@ -1111,29 +1118,29 @@ DESCRIPTION
 
   Code Execution
 
-     Provided code will be executed in an async method.
-     You can access a connected and authenticated SDK with the "sdk" variable.
-     Templated variable passed as the command arguments are also accessible within the same name.
-     Returned value will be printed on the standard output (e.g. 'return await sdk.server.now();').
-     Errors will be caught and printed on the error output (e.g. 'throw new Error("failure");').
+    Provided code will be executed in an async method.
+    You can access a connected and authenticated SDK with the "sdk" variable.
+    Templated variable passed as the command arguments are also accessible within the same name.
+    Returned value will be printed on the standard output (e.g. 'return await sdk.server.now();').
+    Errors will be caught and printed on the error output (e.g. 'throw new Error("failure");').
 
   Provide code
 
-     code can be passed as an argument
-     code will be read from STDIN if available
+    code can be passed as an argument
+    code will be read from STDIN if available
 
-     Examples:
-       - kourou sdk:execute 'return await sdk.server.now()'
-       - kourou sdk:execute 'return await sdk.index.exists(index)' --var 'index="iot-data"'
-       - kourou sdk:execute < snippet.js
-       - echo 'return await sdk.server.now()' | kourou sdk:execute
+    Examples:
+      - kourou sdk:execute 'return await sdk.server.now()'
+      - kourou sdk:execute 'return await sdk.index.exists(index)' --var 'index="iot-data"'
+      - kourou sdk:execute < snippet.js
+      - echo 'return await sdk.server.now()' | kourou sdk:execute
 
   Other
 
-     use the --editor flag to modify the code before executing it
+    use the --editor flag to modify the code before executing it
 
-     Examples:
-       - kourou sdk:execute 'return await sdk.server.now()' --editor
+    Examples:
+      - kourou sdk:execute 'return await sdk.server.now()' --editor
 ```
 
 _See code: [src/commands/sdk/execute.ts](src/commands/sdk/execute.ts)_
@@ -1184,55 +1191,55 @@ DESCRIPTION
 
   Query arguments
 
-     Arguments can be passed and repeated using the --arg or -a flag.
-     Index and collection names can be passed with --index (-i) and --collection (-c) flags
-     ID can be passed with the --id flag.
+    Arguments can be passed and repeated using the --arg or -a flag.
+    Index and collection names can be passed with --index (-i) and --collection (-c) flags
+    ID can be passed with the --id flag.
 
-     Examples:
-       - kourou sdk:query document:delete -i iot -c sensors -a refresh=wait_for
+    Examples:
+      - kourou sdk:query document:delete -i iot -c sensors -a refresh=wait_for
 
   Query body
 
-     Body can be passed with the --body flag with either a JSON or JS string.
-     Body will be read from STDIN if available
+    Body can be passed with the --body flag with either a JSON or JS string.
+    Body will be read from STDIN if available
 
-     Examples:
-       - kourou sdk:query document:create -i iot -c sensors --body '{creation: Date.now())}'
-       - kourou sdk:query admin:loadMappings < mappings.json
-       - echo '{dynamic: "strict"}' | kourou sdk:query collection:create -i iot -c sensors
+    Examples:
+      - kourou sdk:query document:create -i iot -c sensors --body '{creation: Date.now())}'
+      - kourou sdk:query admin:loadMappings < mappings.json
+      - echo '{dynamic: "strict"}' | kourou sdk:query collection:create -i iot -c sensors
 
   Other
 
-     Use the --editor flag to modify the query before sending it to Kuzzle
-     Use the --display flag to display a specific property of the response
+    Use the --editor flag to modify the query before sending it to Kuzzle
+    Use the --display flag to display a specific property of the response
 
-     Examples:
-       - kourou sdk:query document:create -i iot -c sensors --editor
-       - kourou sdk:query server:now --display 'result.now'
+    Examples:
+      - kourou sdk:query document:create -i iot -c sensors --editor
+      - kourou sdk:query server:now --display 'result.now'
 
   Default fallback to API action
 
-     It's possible to use the "sdk:query" command by only specifying the corresponding controller
-     and action as first argument.
+    It's possible to use the "sdk:query" command by only specifying the corresponding controller
+    and action as first argument.
 
-     Kourou will try to infer the first arguments to one the following pattern:
-       - <command> <index>
-       - <command> <body>
-       - <command> <index> <collection>
-       - <command> <index> <collection> <id>
-       - <command> <index> <collection> <body>
-       - <command> <index> <collection> <id> <body>
+    Kourou will try to infer the first arguments to one the following pattern:
+      - <command> <index>
+      - <command> <body>
+      - <command> <index> <collection>
+      - <command> <index> <collection> <id>
+      - <command> <index> <collection> <body>
+      - <command> <index> <collection> <id> <body>
 
-     If a flag is given (-i, -c, --body or --id), then the flag value has priority over
-     argument infering.
+    If a flag is given (-i, -c, --body or --id), then the flag value has priority over
+    argument infering.
 
-     Examples:
-       - kourou collection:list iot
-       - kourou security:createUser '{ "content": { "profileIds": ["default"] } }' --id yagmur
-       - kourou collection:delete iot sensors
-       - kourou document:createOrReplace iot sensors sigfox-1 '{}'
-       - kourou bulk:import iot sensors '{ bulkData: [...] }'
-       - kourou admin:loadMappings < mappings.json
+    Examples:
+      - kourou collection:list iot
+      - kourou security:createUser '{ "content": { "profileIds": ["default"] } }' --id yagmur
+      - kourou collection:delete iot sensors
+      - kourou document:createOrReplace iot sensors sigfox-1 '{}'
+      - kourou bulk:import iot sensors '{ bulkData: [...] }'
+      - kourou admin:loadMappings < mappings.json
 ```
 
 _See code: [src/commands/sdk/query.ts](src/commands/sdk/query.ts)_
@@ -1267,24 +1274,24 @@ DESCRIPTION
   The users will be exported WITHOUT their credentials since Kuzzzle can't access them.
 
   You can either:
-     - Manually re-create credentials for your users
-     - Use the "mustChangePasswordIfSetByAdmin" option Kuzzle password policies (see 
+    - Manually re-create credentials for your users
+    - Use the "mustChangePasswordIfSetByAdmin" option Kuzzle password policies (see 
   https://github.com/kuzzleio/kuzzle-plugin-auth-passport-local/#optional-properties)
-     - Use the "--generate-credentials" flag to auto-generate credentials for your users
+    - Use the "--generate-credentials" flag to auto-generate credentials for your users
 
   Auto-generation of credentials
 
-     With the "--generate-credentials" flag, Kourou will add credentials for the "local" strategy.
-     By default, the username will be the user ID.
-     Use the "generated-username" flag to use an other property than the user ID for the generated username
-     The password will be a strong random 40 characters string
+    With the "--generate-credentials" flag, Kourou will add credentials for the "local" strategy.
+    By default, the username will be the user ID.
+    Use the "generated-username" flag to use an other property than the user ID for the generated username
+    The password will be a strong random 40 characters string
 
   Examples:
 
-     - kourou user:export
-     - kourou user:export --exclude '.*admin.*' --exclude 'supervisor.*'
-     - kourou user:export --generate-credentials
-     - kourou user:export --generate-credentials --generated-username content.email
+    - kourou user:export
+    - kourou user:export --exclude '.*admin.*' --exclude 'supervisor.*'
+    - kourou user:export --generate-credentials
+    - kourou user:export --generate-credentials --generated-username content.email
 ```
 
 _See code: [src/commands/user/export.ts](src/commands/user/export.ts)_
@@ -1446,11 +1453,11 @@ DESCRIPTION
 
   Example:
   {
-     aws: {
-       s3: {
-         keyId: 'b61e267676660c314b006b06'
-       }
-     }
+    aws: {
+      s3: {
+        keyId: 'b61e267676660c314b006b06'
+      }
+    }
   }
 
   Encrypted secrets are meant to be loaded inside an application with Kuzzle Vault.
@@ -1483,8 +1490,8 @@ DESCRIPTION
   Prints an encrypted secrets file content.
 
   This method can display either:
-    - the entire content of the secrets file
-    - a single key value
+   - the entire content of the secrets file
+   - a single key value
 
   See https://github.com/kuzzleio/kuzzle-vault/ for more information.
 

package/lib/commands/collection/export.d.ts

@@ -17,6 +17,7 @@ export default class CollectionExport extends Kommand {
         query: flags.IOptionFlag<string>;
         editor: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
         format: flags.IOptionFlag<string>;
+        fields: flags.IOptionFlag<string | undefined>;
     };
     static args: {
         name: string;

package/lib/commands/collection/export.js

@@ -12,16 +12,22 @@ class CollectionExport extends common_1.Kommand {
         const exportPath = this.flags.path
             ? path_1.default.join(this.flags.path, this.args.index)
             : this.args.index;
+        const fields = this.flags.fields
+            ? this.flags.fields.split(',')
+            : [];
+        if (this.flags.format === 'csv' && fields.length === 0) {
+            this.logInfo('It looks like you are exporting to CSV but you did not select any field. All exportable fields in the mapping will be exported.');
+        }
         let query = this.parseJs(this.flags.query);
         if (this.flags.editor) {
             query = this.fromEditor(query, { json: true });
         }
         const countAll = await this.sdk.document.count(this.args.index, this.args.collection);
         const count = await this.sdk.document.count(this.args.index, this.args.collection, { query });
-        this.logInfo(`Dumping ${count} of ${countAll} documents from collection "${this.args.index}:${this.args.collection}" in ${path_1.default} ...`);
+        this.logInfo(`Dumping ${count} of ${countAll} documents from collection "${this.args.index}:${this.args.collection}" in ${exportPath} ...`);
         fs_1.default.mkdirSync(exportPath, { recursive: true });
         await (0, dump_collection_1.dumpCollectionMappings)(this.sdk, this.args.index, this.args.collection, exportPath, this.flags.format);
-        await (0, dump_collection_1.dumpCollectionData)(this.sdk, this.args.index, this.args.collection, Number(this.flags['batch-size']), exportPath, query, this.flags.format);
+        await (0, dump_collection_1.dumpCollectionData)(this.sdk, this.args.index, this.args.collection, Number(this.flags['batch-size']), exportPath, query, this.flags.format, fields);
         this.logOk(`Collection ${this.args.index}:${this.args.collection} dumped`);
     }
 }
@@ -38,8 +44,19 @@ CollectionExport.flags = Object.assign(Object.assign({ help: command_1.flags.hel
     }), editor: command_1.flags.boolean({
         description: 'Open an editor (EDITOR env variable) to edit the query before sending'
     }), format: command_1.flags.string({
-        description: '"jsonl or kuzzle - kuzzle will export in Kuzzle format usable for internal fixtures and jsonl allows to import that data back with kourou',
-        default: 'JSONL'
+        description: `"kuzzle" will export in Kuzzle format usable for internal fixtures,
+"jsonl" allows to import that data back with kourou,
+"csv" allows to import data into Excel (please, specify the fields to export using the --fields option).`,
+        options: ['jsonl', 'kuzzle', 'csv'],
+        default: 'jsonl'
+    }), fields: command_1.flags.string({
+        description: `[CSV format only] The list of fields to be included in the CSV export in dot-path format.
+
+Example:
+--fields oneField,anotherField,yetAnotherOne.nested.moarNested
+
+Note that the '_id' field is always included in the CSV export. Leaving this option empty implies that all
+exportable fields in the mapping will be exported.`
     }) }, kuzzle_1.kuzzleFlags), { protocol: command_1.flags.string({
         description: 'Kuzzle protocol (http or websocket)',
         default: 'ws',

package/lib/common.d.ts

@@ -27,3 +27,20 @@ export declare abstract class Kommand extends Command {
     fromEditor(defaultContent: Record<string, unknown> | string, options?: EditorParams): Record<string, unknown>;
     parseJs(input?: string): any;
 }
+/**
+ * An iteration-order-safe version of lodash.values
+ *
+ * @param object The object containing the values
+ * @param fields The field names to pick in the right order
+ * @returns The values in the same order as the fields
+ * @see https://lodash.com/docs/4.17.15#values
+ */
+export declare function pickValues(object: any, fields: string[]): any[];
+/**
+ * Formats the value for correct CSV output, avoiding to return
+ * values that would badly serialize in CSV.
+ *
+ * @param value The value to format
+ * @returns The value or a string telling the value is not scalar
+ */
+export declare function formatValueForCSV(value: any): any;

package/lib/common.js

@@ -1,11 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Kommand = void 0;
+exports.formatValueForCSV = exports.pickValues = exports.Kommand = void 0;
 const tslib_1 = require("tslib");
 const command_1 = require("@oclif/command");
 const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
 const node_emoji_1 = (0, tslib_1.__importDefault)(require("node-emoji"));
 const fs_1 = (0, tslib_1.__importDefault)(require("fs"));
+const get_1 = (0, tslib_1.__importDefault)(require("lodash/get"));
+const isObject_1 = (0, tslib_1.__importDefault)(require("lodash/isObject"));
 const kuzzle_1 = require("./support/kuzzle");
 const editor_1 = require("./support/editor");
 class Kommand extends command_1.Command {
@@ -131,3 +133,29 @@ class Kommand extends command_1.Command {
 exports.Kommand = Kommand;
 Kommand.initSdk = true;
 Kommand.readStdin = false;
+/**
+ * An iteration-order-safe version of lodash.values
+ *
+ * @param object The object containing the values
+ * @param fields The field names to pick in the right order
+ * @returns The values in the same order as the fields
+ * @see https://lodash.com/docs/4.17.15#values
+ */
+function pickValues(object, fields) {
+    return fields.map(f => formatValueForCSV((0, get_1.default)(object, f)));
+}
+exports.pickValues = pickValues;
+/**
+ * Formats the value for correct CSV output, avoiding to return
+ * values that would badly serialize in CSV.
+ *
+ * @param value The value to format
+ * @returns The value or a string telling the value is not scalar
+ */
+function formatValueForCSV(value) {
+    if ((0, isObject_1.default)(value)) {
+        return '[NOT_SCALAR]';
+    }
+    return value;
+}
+exports.formatValueForCSV = formatValueForCSV;

package/lib/support/dump-collection.d.ts

@@ -1,2 +1,2 @@
-export declare function dumpCollectionData(sdk: any, index: string, collection: string, batchSize: number, destPath: string, query?: any, format?: string): Promise<unknown>;
+export declare function dumpCollectionData(sdk: any, index: string, collection: string, batchSize: number, destPath: string, query?: any, format?: string, fields?: string[]): Promise<void>;
 export declare function dumpCollectionMappings(sdk: any, index: string, collection: string, destPath: string, format?: string): Promise<void>;

package/lib/support/dump-collection.js

@@ -6,72 +6,222 @@ const fs_1 = (0, tslib_1.__importDefault)(require("fs"));
 const path_1 = (0, tslib_1.__importDefault)(require("path"));
 const cli_ux_1 = (0, tslib_1.__importDefault)(require("cli-ux"));
 const ndjson_1 = (0, tslib_1.__importDefault)(require("ndjson"));
-async function dumpCollectionData(sdk, index, collection, batchSize, destPath, query = {}, format = 'jsonl') {
-    const collectionDir = path_1.default.join(destPath, collection);
-    const filename = path_1.default.join(collectionDir, (format.toLowerCase() === 'jsonl' ? 'documents.jsonl' : 'documents.json'));
-    const writeStream = fs_1.default.createWriteStream(filename);
-    const waitWrite = new Promise(resolve => writeStream.on('finish', resolve));
-    const ndjsonStream = ndjson_1.default.stringify();
-    const options = {
-        scroll: '1m',
-        size: batchSize
-    };
-    const writeLine = (content) => {
+const common_1 = require("../common");
+/**
+ * Flatten an object transform:
+ * {
+ *  title: "kuzzle",
+ *  info : {
+ *    tag: "news"
+ *  }
+ * }
+ *
+ * Into an object like:
+ * {
+ *  title: "kuzzle",
+ *  info.tag: news
+ * }
+ *
+ * @param {Object} target the object we have to flatten
+ * @returns {Object} the flattened object
+ */
+function flattenObject(target) {
+    const output = {};
+    flattenStep(output, target);
+    return output;
+}
+function flattenStep(output, object, prev = null) {
+    const keys = Object.keys(object);
+    for (let i = 0; i < keys.length; i++) {
+        const key = keys[i];
+        const value = object[key];
+        const newKey = prev ? prev + '.' + key : key;
+        if (Object.prototype.toString.call(value) === '[object Object]') {
+            output[newKey] = value;
+            flattenStep(output, value, newKey);
+        }
+        output[newKey] = value;
+    }
+}
+class AbstractDumper {
+    constructor(sdk, index, collection, batchSize, destPath, query = {}) {
+        this.sdk = sdk;
+        this.index = index;
+        this.collection = collection;
+        this.batchSize = batchSize;
+        this.destPath = destPath;
+        this.query = query;
+        this.collectionDir = path_1.default.join(this.destPath, this.collection);
+        this.options = {
+            scroll: '2s',
+            size: batchSize
+        };
+    }
+    /**
+     * One-shot call before the dump. Can be used to
+     * perform setup operations before dumping.
+     *
+     * @returns void
+     */
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    async setup() { }
+    /**
+     * One-shot call before iterating over the data. Can be
+     * used to write the header of the dumped output.
+     */
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    async writeHeader() { }
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    async tearDown() { }
+    /**
+     * The loop that iterates over the documents of the collection and
+     * calls all the other hooks.
+     *
+     * @returns a promise resolving when the dump is finished.
+     */
+    async dump() {
+        this.filename = path_1.default.join(this.collectionDir, `documents.${this.fileExtension}`);
+        this.writeStream = fs_1.default.createWriteStream(this.filename);
+        const waitWrite = new Promise((resolve, reject) => this.writeStream ? this.writeStream.on('finish', resolve) : reject());
+        this.writeStream.on('error', error => {
+            throw error;
+        });
+        await this.setup();
+        await this.writeHeader();
+        let results = await this.sdk.document.search(this.index, this.collection, { query: this.query }, this.options);
+        const progressBar = cli_ux_1.default.progress({
+            format: `Dumping ${this.collection} |{bar}| {percentage}% || {value}/{total} documents`
+        });
+        progressBar.start(results.total, 0);
+        do {
+            progressBar.update(results.fetched);
+            for (const hit of results.hits) {
+                await this.onResult({
+                    _id: hit._id,
+                    _source: hit._source
+                });
+            }
+        } while ((results = await results.next()));
+        await this.tearDown();
+        progressBar.stop();
+        this.writeStream.end();
+        return waitWrite;
+    }
+}
+class JSONLDumper extends AbstractDumper {
+    constructor() {
+        super(...arguments);
+        this.ndjsonStream = ndjson_1.default.stringify();
+    }
+    async setup() {
+        this.ndjsonStream.on('data', (line) => {
+            if (!this.writeStream) {
+                throw new Error('Cannot write data: WriteStream is not initialized.');
+            }
+            this.writeStream.write(line);
+        });
+        return;
+    }
+    async writeHeader() {
+        await this.writeLine({ type: 'collection', index: this.index, collection: this.collection });
+    }
+    writeLine(content) {
         return new Promise(resolve => {
-            if (ndjsonStream.write(content)) {
+            if (this.ndjsonStream.write(content)) {
                 resolve(undefined);
             }
             else {
-                ndjsonStream.once('drain', resolve);
+                this.ndjsonStream.once('drain', resolve);
             }
         });
-    };
-    writeStream.on('error', error => {
-        throw error;
-    });
-    ndjsonStream.on('data', (line) => writeStream.write(line));
-    fs_1.default.mkdirSync(collectionDir, { recursive: true });
-    if (format.toLowerCase() === 'jsonl') {
-        await writeLine({ type: 'collection', index, collection });
-    }
-    let results = await sdk.document.search(index, collection, { query }, options);
-    const progressBar = cli_ux_1.default.progress({
-        format: `Dumping ${collection} |{bar}| {percentage}% || {value}/{total} documents`
-    });
-    progressBar.start(results.total, 0);
-    const rawDocuments = {
-        [index]: {
-            [collection]: []
-        }
-    };
-    do {
-        progressBar.update(results.fetched);
-        for (const hit of results.hits) {
-            let document = null;
-            if (format.toLocaleLowerCase() === 'jsonl') {
-                document = {
-                    _id: hit._id,
-                    body: hit._source
-                };
-                await writeLine(document);
+    }
+    onResult(document) {
+        return this.writeLine({ _id: document._id, body: document._source });
+    }
+    get fileExtension() {
+        return 'jsonl';
+    }
+}
+class KuzzleDumper extends JSONLDumper {
+    constructor() {
+        super(...arguments);
+        this.rawDocuments = {
+            [this.index]: {
+                [this.collection]: []
             }
-            else {
-                rawDocuments[index][collection].push({
-                    index: {
-                        _id: hit._id
-                    }
-                });
-                rawDocuments[index][collection].push(hit._source);
+        };
+    }
+    get fileExtension() {
+        return 'json';
+    }
+    async onResult(document) {
+        this.rawDocuments[this.index][this.collection].push({
+            index: {
+                _id: document._id
+            }
+        });
+        this.rawDocuments[this.index][this.collection].push(document._source);
+        return;
+    }
+    tearDown() {
+        return this.writeLine(this.rawDocuments);
+    }
+}
+class CSVDumper extends AbstractDumper {
+    constructor(sdk, index, collection, batchSize, destPath, query = {}, fields, separator = ',') {
+        super(sdk, index, collection, batchSize, destPath, query);
+        this.fields = fields;
+        this.separator = separator;
+    }
+    get fileExtension() {
+        return 'csv';
+    }
+    async setup() {
+        if (!this.fields.length) {
+            // If no field has been selected, then all fields are selected.
+            const mappings = await this.sdk.collection.getMapping(this.index, this.collection);
+            if (!mappings.properties) {
+                return;
             }
+            this.fields = Object.keys(flattenObject(mappings.properties));
+        }
+        else {
+            // Delete '_id' from the selected fields, since IDs are
+            // _always_ exported.
+            if (this.fields.includes('_id')) {
+                this.fields.splice(this.fields.indexOf('_id'), 1);
+            }
+        }
+    }
+    writeHeader() {
+        return this.writeLine(['_id', ...this.fields].join(this.separator));
+    }
+    async writeLine(line) {
+        if (!this.writeStream) {
+            throw new Error('Cannot write data: WriteStream is not initialized.');
         }
-    } while ((results = await results.next()));
-    if (format.toLocaleLowerCase() === 'kuzzle') {
-        await writeLine(rawDocuments);
-    }
-    progressBar.stop();
-    ndjsonStream.end();
-    writeStream.end();
-    return waitWrite;
+        this.writeStream.write(line);
+        this.writeStream.write('\n');
+        return;
+    }
+    onResult(document) {
+        const values = [document._id, ...(0, common_1.pickValues)(document._source, this.fields)];
+        return this.writeLine(values.join(this.separator));
+    }
+}
+async function dumpCollectionData(sdk, index, collection, batchSize, destPath, query = {}, format = 'jsonl', fields = []) {
+    let dumper;
+    switch (format.toLowerCase()) {
+        case 'jsonl':
+            dumper = new JSONLDumper(sdk, index, collection, batchSize, destPath, query);
+            return dumper.dump();
+        case 'csv':
+            dumper = new CSVDumper(sdk, index, collection, batchSize, destPath, query, fields);
+            return dumper.dump();
+        default:
+            dumper = new KuzzleDumper(sdk, index, collection, batchSize, destPath, query);
+            return dumper.dump();
+    }
 }
 exports.dumpCollectionData = dumpCollectionData;
 async function dumpCollectionMappings(sdk, index, collection, destPath, format = 'jsonl') {

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"0.19.4","commands":{"import":{"id":"import","description":"Recursively imports dump files from a root directory","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"preserve-anonymous":{"name":"preserve-anonymous","type":"boolean","description":"Preserve anonymous rights","allowNo":false},"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"batch-size":{"name":"batch-size","type":"option","description":"Maximum batch size (see limits.documentsWriteCount config)","default":"200"},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or websocket)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"path","description":"Root directory containing dumps","required":true}]},"api-key:check":{"id":"api-key:check","description":"Checks an API key validity","pluginName":"kourou","pluginType":"core","aliases":[],"examples":["kourou api-key:check eyJhbG...QxfQrc"],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or ws)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"token","description":"API key token","required":true}]},"api-key:create":{"id":"api-key:create","description":"Creates a new API Key for a user","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"description":{"name":"description","type":"option","char":"d","description":"API Key description","required":true},"id":{"name":"id","type":"option","description":"API Key unique ID"},"expire":{"name":"expire","type":"option","description":"API Key validity","default":"-1"},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or ws)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"user","description":"User kuid","required":true}]},"api-key:delete":{"id":"api-key:delete","description":"Deletes an API key.","pluginName":"kourou","pluginType":"core","aliases":[],"examples":["kourou vault:delete sigfox-gateway 1k-BF3EBjsXdvA2PR8x"],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or ws)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"user","description":"User kuid","required":true},{"name":"id","description":"API Key unique ID","required":true}]},"api-key:search":{"id":"api-key:search","description":"Lists a user's API Keys.","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"filter":{"name":"filter","type":"option","description":"Filter to match the API Key descriptions"},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or ws)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"user","description":"User kuid","required":true}]},"app:scaffold":{"id":"app:scaffold","description":"Scaffolds a new Kuzzle application","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false}},"args":[{"name":"name","description":"Application name","required":true}]},"app:start-services":{"id":"app:start-services","description":"Starts Kuzzle services (Elasticsearch and Redis)","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"check":{"name":"check","type":"boolean","description":"Check prerequisite before running services","allowNo":false}},"args":[]},"collection:create":{"id":"collection:create","description":"Creates a collection","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or ws)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"index","description":"Index name","required":true},{"name":"collection","description":"Collection name","required":true},{"name":"body","description":"Collection mappings and settings in JS or JSON format. Will be read from STDIN if available"}]},"collection:export":{"id":"collection:export","description":"Exports a collection (JSONL format)","pluginName":"kourou","pluginType":"core","aliases":[],"examples":["kourou collection:export nyc-open-data yellow-taxi","kourou collection:export nyc-open-data yellow-taxi --query '{ term: { city: \"Saigon\" } }'"],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"path":{"name":"path","type":"option","description":"Dump root directory"},"batch-size":{"name":"batch-size","type":"option","description":"Maximum batch size (see limits.documentsFetchCount config)","default":"2000"},"query":{"name":"query","type":"option","description":"Only dump documents matching the query (JS or JSON format)","default":"{}"},"editor":{"name":"editor","type":"boolean","description":"Open an editor (EDITOR env variable) to edit the query before sending","allowNo":false},"format":{"name":"format","type":"option","description":"\"jsonl or kuzzle - kuzzle will export in Kuzzle format usable for internal fixtures and jsonl allows to import that data back with kourou","default":"JSONL"},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or websocket)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"index","description":"Index name","required":true},{"name":"collection","description":"Collection name","required":true}]},"collection:import":{"id":"collection:import","description":"Imports a collection","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"batch-size":{"name":"batch-size","type":"option","description":"Maximum batch size (see limits.documentsWriteCount config)","default":"200"},"index":{"name":"index","type":"option","description":"If set, override the index destination name"},"collection":{"name":"collection","type":"option","description":"If set, override the collection destination name"},"no-mappings":{"name":"no-mappings","type":"boolean","description":"Skip collection mappings","allowNo":false},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or websocket)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"path","description":"Dump directory path","required":true}]},"config:diff":{"id":"config:diff","description":"Returns differences between two Kuzzle configuration files (kuzzlerc)","pluginName":"kourou","pluginType":"core","aliases":[],"examples":["kourou config:diff config/local/kuzzlerc config/production/kuzzlerc"],"flags":{"strict":{"name":"strict","type":"boolean","description":"Exit with an error if differences are found","allowNo":false},"values":{"name":"values","type":"boolean","description":"Also displays value changes","allowNo":false}},"args":[{"name":"first","description":"First configuration file","required":true},{"name":"second","description":"Second configuration file","required":true}]},"document:search":{"id":"document:search","description":"Searches for documents","pluginName":"kourou","pluginType":"core","aliases":[],"examples":["kourou document:search iot sensors '{ equals: { name: \"corona\" } }'","kourou document:search iot sensors '{ match: { name: \"cOrOnna\" } }' -a lang=elasticsearch","kourou document:search iot sensors --editor"],"flags":{"sort":{"name":"sort","type":"option","description":"Sort in JS or JSON format.","default":"{}"},"from":{"name":"from","type":"option","description":"Optional offset"},"size":{"name":"size","type":"option","description":"Optional page size"},"scroll":{"name":"scroll","type":"option","description":"Optional scroll TTL"},"lang":{"name":"lang","type":"option","description":"Specify the query language to use","default":"koncorde"},"editor":{"name":"editor","type":"boolean","description":"Open an editor (EDITOR env variable) to edit the request before sending","allowNo":false},"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or ws)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"index","description":"Index name","required":true},{"name":"collection","description":"Collection name","required":true},{"name":"query","description":"Search query in JS or JSON format."}]},"es:migrate":{"id":"es:migrate","description":"Migrate all the index from one Elasticsearch server to another","pluginName":"kourou","pluginType":"core","aliases":[],"examples":["kourou es:migrate --src http://elasticsearch:9200 --dest http://otherElasticsearch:9200 --reset --batch-size 2000","kourou es:migrate --src http://elasticsearch:9200 --dest http://otherElasticsearch:9200 --reset --batch-size 2000 --no-interactive"],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"src":{"name":"src","type":"option","description":"Source Elasticsearch server URL","required":true},"dest":{"name":"dest","type":"option","description":"Destination Elasticsearch server URL","required":true},"reset":{"name":"reset","type":"boolean","description":"Reset destination Elasticsearch server","allowNo":false},"batch-size":{"name":"batch-size","type":"option","description":"How many documents to move in batch per operation","default":1000},"no-interactive":{"name":"no-interactive","type":"boolean","description":"Skip confirmation interactive prompts (perfect for scripting)","allowNo":false}},"args":[]},"file:decrypt":{"id":"file:decrypt","description":"Decrypts an encrypted file.","pluginName":"kourou","pluginType":"core","aliases":[],"examples":["kourou file:decrypt books/cryptonomicon.txt.enc --vault-key <vault-key>","kourou file:decrypt books/cryptonomicon.txt.enc -o books/cryptonomicon.txt --vault-key <vault-key>"],"flags":{"force":{"name":"force","type":"boolean","char":"f","description":"Overwrite the output file if it already exists","allowNo":false},"output-file":{"name":"output-file","type":"option","char":"o","description":"Output file (default: remove \".enc\")"},"vault-key":{"name":"vault-key","type":"option","description":"Kuzzle Vault Key (or KUZZLE_VAULT_KEY)"}},"args":[{"name":"file","description":"Encrypted file","required":true}]},"file:encrypt":{"id":"file:encrypt","description":"Encrypts an entire file.","pluginName":"kourou","pluginType":"core","aliases":[],"examples":["kourou file:encrypt books/cryptonomicon.txt --vault-key <vault-key>","kourou file:encrypt books/cryptonomicon.txt -o books/cryptonomicon.txt.enc --vault-key <vault-key>"],"flags":{"force":{"name":"force","type":"boolean","char":"f","description":"Overwrite the output file if it already exists","allowNo":false},"output-file":{"name":"output-file","type":"option","char":"o","description":"Output file (default: <filename>.enc)"},"vault-key":{"name":"vault-key","type":"option","description":"Kuzzle Vault Key (or KUZZLE_VAULT_KEY)"}},"args":[{"name":"file","description":"Filename","required":true}]},"file:test":{"id":"file:test","description":"Tests if an encrypted file can be decrypted.","pluginName":"kourou","pluginType":"core","aliases":[],"examples":["kourou file:test books/cryptonomicon.txt.enc --vault-key <vault-key>"],"flags":{"vault-key":{"name":"vault-key","type":"option","description":"Kuzzle Vault Key (or KUZZLE_VAULT_KEY)"}},"args":[{"name":"file","description":"Encrypted file","required":true}]},"index:export":{"id":"index:export","description":"Exports an index (JSONL or Kuzzle format)","pluginName":"kourou","pluginType":"core","aliases":[],"examples":["kourou index:export nyc-open-data","kourou index:export nyc-open-data --query '{\"range\":{\"_kuzzle_info.createdAt\":{\"gt\":1632935638866}}}'"],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"path":{"name":"path","type":"option","description":"Dump root directory"},"batch-size":{"name":"batch-size","type":"option","description":"Maximum batch size (see limits.documentsFetchCount config)","default":"2000"},"query":{"name":"query","type":"option","description":"Only dump documents in collections matching the query (JS or JSON format)","default":"{}"},"format":{"name":"format","type":"option","description":"\"jsonl or kuzzle - kuzzle will export in Kuzzle format usable for internal fixtures and jsonl allows to import that data back with kourou","default":"jsonl"},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or websocket)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"index","description":"Index name","required":true}]},"index:import":{"id":"index:import","description":"Imports an index (JSONL format)","pluginName":"kourou","pluginType":"core","aliases":[],"examples":["kourou index:import ./dump/iot-data","kourou index:import ./dump/iot-data --index iot-data-production --no-mappings"],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"batch-size":{"name":"batch-size","type":"option","description":"Maximum batch size (see limits.documentsWriteCount config)","default":"200"},"index":{"name":"index","type":"option","description":"If set, override the index destination name"},"no-mappings":{"name":"no-mappings","type":"boolean","description":"Skip collections mappings","allowNo":false},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or websocket)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"path","description":"Dump directory or file","required":true}]},"instance:kill":{"id":"instance:kill","description":"Stop and remove all the containers of a running kuzzle instance","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"instance":{"name":"instance","type":"option","char":"i","description":"Kuzzle instance name [ex: stack-0]"},"all":{"name":"all","type":"boolean","char":"a","description":"Kill all instances","allowNo":false}},"args":[]},"instance:list":{"id":"instance:list","description":"Lists the Kuzzle running instances","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{},"args":[]},"instance:logs":{"id":"instance:logs","description":"Displays the logs of a running Kuzzle","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"instance":{"name":"instance","type":"option","char":"i","description":"Kuzzle instance name"},"follow":{"name":"follow","type":"boolean","char":"f","description":"Follow log output","allowNo":false}},"args":[]},"instance:spawn":{"id":"instance:spawn","description":"Spawn a new Kuzzle instance","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"check":{"name":"check","type":"boolean","description":"Check prerequisite before running Kuzzle","allowNo":false},"version":{"name":"version","type":"option","char":"v","description":"Core-version of the instance to spawn","default":"2"}},"args":[]},"profile:export":{"id":"profile:export","description":"Exports profiles","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"path":{"name":"path","type":"option","description":"Dump directory","default":"profiles"},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or websocket)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[]},"profile:import":{"id":"profile:import","description":"Imports profiles","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or websocket)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"path","description":"Dump file","required":true}]},"realtime:subscribe":{"id":"realtime:subscribe","description":"Subscribes to realtime notifications","pluginName":"kourou","pluginType":"core","aliases":[],"examples":["kourou realtime:subscribe iot-data sensors","kourou realtime:subscribe iot-data sensors '{ range: { temperature: { gt: 0 } } }'","kourou realtime:subscribe iot-data sensors '{ exists: \"position\" }' --scope out","kourou realtime:subscribe iot-data sensors --users all --volatile '{ clientId: \"citizen-kane\" }'","kourou realtime:subscribe iot-data sensors --display result._source.temperature"],"flags":{"scope":{"name":"scope","type":"option","description":"Subscribe to document entering or leaving the scope (all, in, out, none)","default":"all"},"users":{"name":"users","type":"option","description":"Subscribe to users entering or leaving the room (all, in, out, none)","default":"all"},"volatile":{"name":"volatile","type":"option","description":"Additional subscription information used in user join/leave notifications","default":"{}"},"display":{"name":"display","type":"option","description":"Path of the property to display from the notification (empty string to display everything)","default":"result"},"editor":{"name":"editor","type":"boolean","description":"Open an editor (EDITOR env variable) to edit the filters before subscribing.","allowNo":false},"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (only websocket for realtime)","default":"websocket"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"index","description":"Index name","required":true},{"name":"collection","description":"Collection name","required":true},{"name":"filters","description":"Set of Koncorde filters"}]},"redis:list-keys":{"id":"redis:list-keys","description":"Lists keys stored in Redis","pluginName":"kourou","pluginType":"core","aliases":[],"examples":["kourou redis:list-keys \"*cluster*\"","kourou redis:list-keys \"counters/*\" --remove"],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"remove":{"name":"remove","type":"boolean","description":"Remove matching keys","allowNo":false},"size":{"name":"size","type":"option","description":"Page size","default":"100"},"max":{"name":"max","type":"option","description":"Maximum number of page to retrieve (-1 to retrieve everything)","default":"-1"},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or ws)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"match","description":"Match Redis keys with a pattern","default":"*"}]},"role:export":{"id":"role:export","description":"Exports roles","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"path":{"name":"path","type":"option","description":"Dump directory","default":"roles"},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or websocket)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[]},"role:import":{"id":"role:import","description":"Import roles","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"preserve-anonymous":{"name":"preserve-anonymous","type":"boolean","description":"Preserve anonymous rights","allowNo":false},"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or websocket)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"path","description":"Dump file","required":true}]},"sdk:execute":{"id":"sdk:execute","description":"\nExecutes arbitrary code.\n\nCode Execution\n\n  Provided code will be executed in an async method.\n  You can access a connected and authenticated SDK with the \"sdk\" variable.\n  Templated variable passed as the command arguments are also accessible within the same name.\n  Returned value will be printed on the standard output (e.g. 'return await sdk.server.now();').\n  Errors will be caught and printed on the error output (e.g. 'throw new Error(\"failure\");').\n\nProvide code\n\n  code can be passed as an argument\n  code will be read from STDIN if available\n\n  Examples:\n    - kourou sdk:execute 'return await sdk.server.now()'\n    - kourou sdk:execute 'return await sdk.index.exists(index)' --var 'index=\"iot-data\"'\n    - kourou sdk:execute < snippet.js\n    - echo 'return await sdk.server.now()' | kourou sdk:execute\n\nOther\n\n  use the --editor flag to modify the code before executing it\n\n  Examples:\n    - kourou sdk:execute 'return await sdk.server.now()' --editor\n","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"var":{"name":"var","type":"option","char":"v","description":"Additional arguments injected into the code. (eg: --var 'index=\"iot-data\"'"},"editor":{"name":"editor","type":"boolean","description":"Open an editor (EDITOR env variable) to edit the code before executing it.","allowNo":false},"keep-alive":{"name":"keep-alive","type":"boolean","description":"Keep the connection running (websocket only)","allowNo":false},"print-raw":{"name":"print-raw","type":"boolean","description":"Print only the script result to stdout","allowNo":false},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or ws)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"code","description":"Code to execute. Will be read from STDIN if available.","required":false}]},"sdk:query":{"id":"sdk:query","description":"\nExecutes an API query.\n\nQuery arguments\n\n  Arguments can be passed and repeated using the --arg or -a flag.\n  Index and collection names can be passed with --index (-i) and --collection (-c) flags\n  ID can be passed with the --id flag.\n\n  Examples:\n    - kourou sdk:query document:delete -i iot -c sensors -a refresh=wait_for\n\nQuery body\n\n  Body can be passed with the --body flag with either a JSON or JS string.\n  Body will be read from STDIN if available\n\n  Examples:\n    - kourou sdk:query document:create -i iot -c sensors --body '{creation: Date.now())}'\n    - kourou sdk:query admin:loadMappings < mappings.json\n    - echo '{dynamic: \"strict\"}' | kourou sdk:query collection:create -i iot -c sensors\n\nOther\n\n  Use the --editor flag to modify the query before sending it to Kuzzle\n  Use the --display flag to display a specific property of the response\n\n  Examples:\n    - kourou sdk:query document:create -i iot -c sensors --editor\n    - kourou sdk:query server:now --display 'result.now'\n\nDefault fallback to API action\n\n  It's possible to use the \"sdk:query\" command by only specifying the corresponding controller\n  and action as first argument.\n\n  Kourou will try to infer the first arguments to one the following pattern:\n    - <command> <index>\n    - <command> <body>\n    - <command> <index> <collection>\n    - <command> <index> <collection> <id>\n    - <command> <index> <collection> <body>\n    - <command> <index> <collection> <id> <body>\n\n  If a flag is given (-i, -c, --body or --id), then the flag value has priority over\n  argument infering.\n\n  Examples:\n    - kourou collection:list iot\n    - kourou security:createUser '{ \"content\": { \"profileIds\": [\"default\"] } }' --id yagmur\n    - kourou collection:delete iot sensors\n    - kourou document:createOrReplace iot sensors sigfox-1 '{}'\n    - kourou bulk:import iot sensors '{ bulkData: [...] }'\n    - kourou admin:loadMappings < mappings.json\n","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"arg":{"name":"arg","type":"option","char":"a","description":"Additional argument. Repeatable. (e.g. \"-a refresh=wait_for\")"},"body":{"name":"body","type":"option","description":"Request body in JS or JSON format. Will be read from STDIN if available.","default":"{}"},"editor":{"name":"editor","type":"boolean","description":"Open an editor (EDITOR env variable) to edit the request before sending.","allowNo":false},"body-editor":{"name":"body-editor","type":"boolean","description":"Open an editor (EDITOR env variable) to edit the body before sending.","allowNo":false},"index":{"name":"index","type":"option","char":"i","description":"Index argument"},"collection":{"name":"collection","type":"option","char":"c","description":"Collection argument"},"id":{"name":"id","type":"option","description":"ID argument (_id)"},"display":{"name":"display","type":"option","description":"Path of the property to display from the response (empty string to display the result)","default":"result"},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or ws)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"controller:action","description":"Controller and action (eg: \"server:now\")","required":true}]},"user:export-mappings":{"id":"user:export-mappings","description":"Exports users collection mappings to JSON.","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"path":{"name":"path","type":"option","description":"Dump directory","default":"users"},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or websocket)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[]},"user:export":{"id":"user:export","description":"\nExports users to JSON.\n\nThe users will be exported WITHOUT their credentials since Kuzzzle can't access them.\n\nYou can either:\n  - Manually re-create credentials for your users\n  - Use the \"mustChangePasswordIfSetByAdmin\" option Kuzzle password policies (see https://github.com/kuzzleio/kuzzle-plugin-auth-passport-local/#optional-properties)\n  - Use the \"--generate-credentials\" flag to auto-generate credentials for your users\n\nAuto-generation of credentials\n\n  With the \"--generate-credentials\" flag, Kourou will add credentials for the \"local\" strategy.\n  By default, the username will be the user ID.\n  Use the \"generated-username\" flag to use an other property than the user ID for the generated username\n  The password will be a strong random 40 characters string\n\nExamples:\n\n  - kourou user:export\n  - kourou user:export --exclude '.*admin.*' --exclude 'supervisor.*'\n  - kourou user:export --generate-credentials\n  - kourou user:export --generate-credentials --generated-username content.email\n","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"path":{"name":"path","type":"option","description":"Dump directory","default":"users"},"exclude":{"name":"exclude","type":"option","description":"Exclude users by matching their IDs with a regexp"},"generate-credentials":{"name":"generate-credentials","type":"boolean","description":"Generate credentials with a random password for users","allowNo":false},"generated-username":{"name":"generated-username","type":"option","description":"User content property used as a username for local credentials","default":"_id"},"batch-size":{"name":"batch-size","type":"option","description":"Maximum batch size (see limits.documentsFetchCount config)","default":"2000"},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or websocket)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[]},"user:import-mappings":{"id":"user:import-mappings","description":"Imports users collection mappings","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or websocket)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"path","description":"Dump file","required":true}]},"user:import":{"id":"user:import","description":"Imports users","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or websocket)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"path","description":"Dump file","required":true}]},"vault:add":{"id":"vault:add","description":"\nAdds an encrypted key to an encrypted secrets file.\n\nA new secrets file is created if it does not yet exist.\n\nEncrypted secrets are meant to be loaded inside an application with Kuzzle Vault.\n\nSee https://github.com/kuzzleio/kuzzle-vault/ for more information.\n","pluginName":"kourou","pluginType":"core","aliases":[],"examples":["kourou vault:add config/secrets.enc.json aws.s3.keyId b61e267676660c314b006b06 --vault-key <vault-key>"],"flags":{"vault-key":{"name":"vault-key","type":"option","description":"Kuzzle Vault Key (or KUZZLE_VAULT_KEY)"}},"args":[{"name":"secrets-file","description":"Encrypted secrets file","required":true},{"name":"key","description":"Path to the key (lodash style)","required":true},{"name":"value","description":"Value to encrypt","required":true}]},"vault:decrypt":{"id":"vault:decrypt","description":"\nDecrypts an entire secrets file.\n\nDecrypted secrets file must NEVER be committed into the repository.\n\nSee https://github.com/kuzzleio/kuzzle-vault/ for more information.\n","pluginName":"kourou","pluginType":"core","aliases":[],"examples":["kourou vault:decrypt config/secrets.enc.json --vault-key <vault-key>","kourou vault:decrypt config/secrets.enc.json -o config/secrets.json --vault-key <vault-key>"],"flags":{"force":{"name":"force","type":"boolean","char":"f","description":"Overwrite the output file if it already exists","allowNo":false},"output-file":{"name":"output-file","type":"option","char":"o","description":"Output file (default: remove \".enc\")"},"vault-key":{"name":"vault-key","type":"option","description":"Kuzzle Vault Key (or KUZZLE_VAULT_KEY)"}},"args":[{"name":"file","description":"File containing encrypted secrets","required":true}]},"vault:encrypt":{"id":"vault:encrypt","description":"\nEncrypts an entire secrets file.\n\nThe secrets file must be in JSON format and it must contain only strings or objects.\n\nExample:\n{\n  aws: {\n    s3: {\n      keyId: 'b61e267676660c314b006b06'\n    }\n  }\n}\n\nEncrypted secrets are meant to be loaded inside an application with Kuzzle Vault.\n\nSee https://github.com/kuzzleio/kuzzle-vault/ for more information.\n","pluginName":"kourou","pluginType":"core","aliases":[],"examples":["kourou vault:encrypt config/secrets.json --vault-key <vault-key>","kourou vault:encrypt config/secrets.json -o config/secrets_prod.enc.json --vault-key <vault-key>"],"flags":{"force":{"name":"force","type":"boolean","char":"f","description":"Overwrite the output file if it already exists","allowNo":false},"output-file":{"name":"output-file","type":"option","char":"o","description":"Output file (default: <file>.enc.json)"},"vault-key":{"name":"vault-key","type":"option","description":"Kuzzle Vault Key (or KUZZLE_VAULT_KEY)"}},"args":[{"name":"file","description":"File containing unencrypted secrets","required":true}]},"vault:show":{"id":"vault:show","description":"\nPrints an encrypted secrets file content.\n\nThis method can display either:\n - the entire content of the secrets file\n - a single key value\n\nSee https://github.com/kuzzleio/kuzzle-vault/ for more information.\n","pluginName":"kourou","pluginType":"core","aliases":[],"examples":["kourou vault:show config/secrets.enc.json --vault-key <vault-key>","kourou vault:show config/secrets.enc.json aws.s3.secretKey --vault-key <vault-key>"],"flags":{"vault-key":{"name":"vault-key","type":"option","description":"Kuzzle Vault Key (or KUZZLE_VAULT_KEY)"}},"args":[{"name":"secrets-file","description":"Encrypted secrets file","required":true},{"name":"key","description":"Path to a key (lodash style)"}]},"vault:test":{"id":"vault:test","description":"\nTests if an encrypted secrets file can be decrypted.\n\nSee https://github.com/kuzzleio/kuzzle-vault/ for more information.\n","pluginName":"kourou","pluginType":"core","aliases":[],"examples":["kourou vault:test config/secrets.enc.json --vault-key <vault-key>"],"flags":{"vault-key":{"name":"vault-key","type":"option","description":"Kuzzle Vault Key (or KUZZLE_VAULT_KEY)"}},"args":[{"name":"secrets-file","description":"Encrypted secrets file","required":true}]},"es:indices:cat":{"id":"es:indices:cat","description":"Lists available ES indexes","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"node":{"name":"node","type":"option","char":"n","description":"Elasticsearch server URL","default":"http://localhost:9200"},"grep":{"name":"grep","type":"option","char":"g","description":"Match output with pattern"}},"args":[]},"es:indices:get":{"id":"es:indices:get","description":"Gets a document from ES","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"node":{"name":"node","type":"option","char":"n","description":"Elasticsearch server URL","default":"http://localhost:9200"}},"args":[{"name":"index","description":"ES Index name","required":true},{"name":"id","description":"Document ID","required":true}]},"es:indices:insert":{"id":"es:indices:insert","description":"Inserts a document directly into ES (will replace if exists)","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"body":{"name":"body","type":"option","description":"Document body in JSON","default":"{}"},"id":{"name":"id","type":"option","description":"Document ID"},"node":{"name":"node","type":"option","char":"n","description":"Elasticsearch server URL","default":"http://localhost:9200"},"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false}},"args":[{"name":"index","description":"ES Index name","required":true}]},"es:snapshot:create-repository":{"id":"es:snapshot:create-repository","description":"Create a FS snapshot repository inside an ES instance","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"compress":{"name":"compress","type":"boolean","description":"Compress data when storing them","allowNo":false},"node":{"name":"node","type":"option","char":"n","description":"Elasticsearch server URL","default":"http://localhost:9200"},"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false}},"args":[{"name":"repository","description":"ES repository name","required":true},{"name":"location","description":"ES snapshot repository location","required":true}]},"es:snapshot:create":{"id":"es:snapshot:create","description":"Create a snapshot repository inside an ES instance","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"node":{"name":"node","type":"option","char":"n","description":"Elasticsearch server URL","default":"http://localhost:9200"},"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false}},"args":[{"name":"repository","description":"ES repository name","required":true},{"name":"name","description":"ES snapshot name","required":true}]},"es:snapshot:list":{"id":"es:snapshot:list","description":"List all snapshot from a repository acknowledge by an ES instance","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"node":{"name":"node","type":"option","char":"n","description":"Elasticsearch server URL","default":"http://localhost:9200"},"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false}},"args":[{"name":"repository","description":"Name of repository from which to fetch the snapshot information","required":true}]},"es:snapshot:restore":{"id":"es:snapshot:restore","description":"Restore a snapshot into an ES instance","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"node":{"name":"node","type":"option","char":"n","description":"Elasticsearch server URL","default":"http://localhost:9200"},"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false}},"args":[{"name":"repository","description":"ES repository name","required":true},{"name":"name","description":"ES snapshot name","required":true}]}}}
+{"version":"0.19.5","commands":{"import":{"id":"import","description":"Recursively imports dump files from a root directory","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"preserve-anonymous":{"name":"preserve-anonymous","type":"boolean","description":"Preserve anonymous rights","allowNo":false},"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"batch-size":{"name":"batch-size","type":"option","description":"Maximum batch size (see limits.documentsWriteCount config)","default":"200"},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or websocket)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"path","description":"Root directory containing dumps","required":true}]},"api-key:check":{"id":"api-key:check","description":"Checks an API key validity","pluginName":"kourou","pluginType":"core","aliases":[],"examples":["kourou api-key:check eyJhbG...QxfQrc"],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or ws)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"token","description":"API key token","required":true}]},"api-key:create":{"id":"api-key:create","description":"Creates a new API Key for a user","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"description":{"name":"description","type":"option","char":"d","description":"API Key description","required":true},"id":{"name":"id","type":"option","description":"API Key unique ID"},"expire":{"name":"expire","type":"option","description":"API Key validity","default":"-1"},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or ws)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"user","description":"User kuid","required":true}]},"api-key:delete":{"id":"api-key:delete","description":"Deletes an API key.","pluginName":"kourou","pluginType":"core","aliases":[],"examples":["kourou vault:delete sigfox-gateway 1k-BF3EBjsXdvA2PR8x"],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or ws)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"user","description":"User kuid","required":true},{"name":"id","description":"API Key unique ID","required":true}]},"api-key:search":{"id":"api-key:search","description":"Lists a user's API Keys.","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"filter":{"name":"filter","type":"option","description":"Filter to match the API Key descriptions"},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or ws)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"user","description":"User kuid","required":true}]},"app:scaffold":{"id":"app:scaffold","description":"Scaffolds a new Kuzzle application","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false}},"args":[{"name":"name","description":"Application name","required":true}]},"app:start-services":{"id":"app:start-services","description":"Starts Kuzzle services (Elasticsearch and Redis)","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"check":{"name":"check","type":"boolean","description":"Check prerequisite before running services","allowNo":false}},"args":[]},"collection:create":{"id":"collection:create","description":"Creates a collection","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or ws)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"index","description":"Index name","required":true},{"name":"collection","description":"Collection name","required":true},{"name":"body","description":"Collection mappings and settings in JS or JSON format. Will be read from STDIN if available"}]},"collection:export":{"id":"collection:export","description":"Exports a collection (JSONL format)","pluginName":"kourou","pluginType":"core","aliases":[],"examples":["kourou collection:export nyc-open-data yellow-taxi","kourou collection:export nyc-open-data yellow-taxi --query '{ term: { city: \"Saigon\" } }'"],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"path":{"name":"path","type":"option","description":"Dump root directory"},"batch-size":{"name":"batch-size","type":"option","description":"Maximum batch size (see limits.documentsFetchCount config)","default":"2000"},"query":{"name":"query","type":"option","description":"Only dump documents matching the query (JS or JSON format)","default":"{}"},"editor":{"name":"editor","type":"boolean","description":"Open an editor (EDITOR env variable) to edit the query before sending","allowNo":false},"format":{"name":"format","type":"option","description":"\"kuzzle\" will export in Kuzzle format usable for internal fixtures,\n\"jsonl\" allows to import that data back with kourou,\n\"csv\" allows to import data into Excel (please, specify the fields to export using the --fields option).","options":["jsonl","kuzzle","csv"],"default":"jsonl"},"fields":{"name":"fields","type":"option","description":"[CSV format only] The list of fields to be included in the CSV export in dot-path format.\n\nExample:\n--fields oneField,anotherField,yetAnotherOne.nested.moarNested\n\nNote that the '_id' field is always included in the CSV export. Leaving this option empty implies that all\nexportable fields in the mapping will be exported."},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or websocket)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"index","description":"Index name","required":true},{"name":"collection","description":"Collection name","required":true}]},"collection:import":{"id":"collection:import","description":"Imports a collection","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"batch-size":{"name":"batch-size","type":"option","description":"Maximum batch size (see limits.documentsWriteCount config)","default":"200"},"index":{"name":"index","type":"option","description":"If set, override the index destination name"},"collection":{"name":"collection","type":"option","description":"If set, override the collection destination name"},"no-mappings":{"name":"no-mappings","type":"boolean","description":"Skip collection mappings","allowNo":false},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or websocket)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"path","description":"Dump directory path","required":true}]},"config:diff":{"id":"config:diff","description":"Returns differences between two Kuzzle configuration files (kuzzlerc)","pluginName":"kourou","pluginType":"core","aliases":[],"examples":["kourou config:diff config/local/kuzzlerc config/production/kuzzlerc"],"flags":{"strict":{"name":"strict","type":"boolean","description":"Exit with an error if differences are found","allowNo":false},"values":{"name":"values","type":"boolean","description":"Also displays value changes","allowNo":false}},"args":[{"name":"first","description":"First configuration file","required":true},{"name":"second","description":"Second configuration file","required":true}]},"document:search":{"id":"document:search","description":"Searches for documents","pluginName":"kourou","pluginType":"core","aliases":[],"examples":["kourou document:search iot sensors '{ equals: { name: \"corona\" } }'","kourou document:search iot sensors '{ match: { name: \"cOrOnna\" } }' -a lang=elasticsearch","kourou document:search iot sensors --editor"],"flags":{"sort":{"name":"sort","type":"option","description":"Sort in JS or JSON format.","default":"{}"},"from":{"name":"from","type":"option","description":"Optional offset"},"size":{"name":"size","type":"option","description":"Optional page size"},"scroll":{"name":"scroll","type":"option","description":"Optional scroll TTL"},"lang":{"name":"lang","type":"option","description":"Specify the query language to use","default":"koncorde"},"editor":{"name":"editor","type":"boolean","description":"Open an editor (EDITOR env variable) to edit the request before sending","allowNo":false},"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or ws)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"index","description":"Index name","required":true},{"name":"collection","description":"Collection name","required":true},{"name":"query","description":"Search query in JS or JSON format."}]},"es:migrate":{"id":"es:migrate","description":"Migrate all the index from one Elasticsearch server to another","pluginName":"kourou","pluginType":"core","aliases":[],"examples":["kourou es:migrate --src http://elasticsearch:9200 --dest http://otherElasticsearch:9200 --reset --batch-size 2000","kourou es:migrate --src http://elasticsearch:9200 --dest http://otherElasticsearch:9200 --reset --batch-size 2000 --no-interactive"],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"src":{"name":"src","type":"option","description":"Source Elasticsearch server URL","required":true},"dest":{"name":"dest","type":"option","description":"Destination Elasticsearch server URL","required":true},"reset":{"name":"reset","type":"boolean","description":"Reset destination Elasticsearch server","allowNo":false},"batch-size":{"name":"batch-size","type":"option","description":"How many documents to move in batch per operation","default":1000},"no-interactive":{"name":"no-interactive","type":"boolean","description":"Skip confirmation interactive prompts (perfect for scripting)","allowNo":false}},"args":[]},"file:decrypt":{"id":"file:decrypt","description":"Decrypts an encrypted file.","pluginName":"kourou","pluginType":"core","aliases":[],"examples":["kourou file:decrypt books/cryptonomicon.txt.enc --vault-key <vault-key>","kourou file:decrypt books/cryptonomicon.txt.enc -o books/cryptonomicon.txt --vault-key <vault-key>"],"flags":{"force":{"name":"force","type":"boolean","char":"f","description":"Overwrite the output file if it already exists","allowNo":false},"output-file":{"name":"output-file","type":"option","char":"o","description":"Output file (default: remove \".enc\")"},"vault-key":{"name":"vault-key","type":"option","description":"Kuzzle Vault Key (or KUZZLE_VAULT_KEY)"}},"args":[{"name":"file","description":"Encrypted file","required":true}]},"file:encrypt":{"id":"file:encrypt","description":"Encrypts an entire file.","pluginName":"kourou","pluginType":"core","aliases":[],"examples":["kourou file:encrypt books/cryptonomicon.txt --vault-key <vault-key>","kourou file:encrypt books/cryptonomicon.txt -o books/cryptonomicon.txt.enc --vault-key <vault-key>"],"flags":{"force":{"name":"force","type":"boolean","char":"f","description":"Overwrite the output file if it already exists","allowNo":false},"output-file":{"name":"output-file","type":"option","char":"o","description":"Output file (default: <filename>.enc)"},"vault-key":{"name":"vault-key","type":"option","description":"Kuzzle Vault Key (or KUZZLE_VAULT_KEY)"}},"args":[{"name":"file","description":"Filename","required":true}]},"file:test":{"id":"file:test","description":"Tests if an encrypted file can be decrypted.","pluginName":"kourou","pluginType":"core","aliases":[],"examples":["kourou file:test books/cryptonomicon.txt.enc --vault-key <vault-key>"],"flags":{"vault-key":{"name":"vault-key","type":"option","description":"Kuzzle Vault Key (or KUZZLE_VAULT_KEY)"}},"args":[{"name":"file","description":"Encrypted file","required":true}]},"index:export":{"id":"index:export","description":"Exports an index (JSONL or Kuzzle format)","pluginName":"kourou","pluginType":"core","aliases":[],"examples":["kourou index:export nyc-open-data","kourou index:export nyc-open-data --query '{\"range\":{\"_kuzzle_info.createdAt\":{\"gt\":1632935638866}}}'"],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"path":{"name":"path","type":"option","description":"Dump root directory"},"batch-size":{"name":"batch-size","type":"option","description":"Maximum batch size (see limits.documentsFetchCount config)","default":"2000"},"query":{"name":"query","type":"option","description":"Only dump documents in collections matching the query (JS or JSON format)","default":"{}"},"format":{"name":"format","type":"option","description":"\"jsonl or kuzzle - kuzzle will export in Kuzzle format usable for internal fixtures and jsonl allows to import that data back with kourou","default":"jsonl"},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or websocket)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"index","description":"Index name","required":true}]},"index:import":{"id":"index:import","description":"Imports an index (JSONL format)","pluginName":"kourou","pluginType":"core","aliases":[],"examples":["kourou index:import ./dump/iot-data","kourou index:import ./dump/iot-data --index iot-data-production --no-mappings"],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"batch-size":{"name":"batch-size","type":"option","description":"Maximum batch size (see limits.documentsWriteCount config)","default":"200"},"index":{"name":"index","type":"option","description":"If set, override the index destination name"},"no-mappings":{"name":"no-mappings","type":"boolean","description":"Skip collections mappings","allowNo":false},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or websocket)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"path","description":"Dump directory or file","required":true}]},"instance:kill":{"id":"instance:kill","description":"Stop and remove all the containers of a running kuzzle instance","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"instance":{"name":"instance","type":"option","char":"i","description":"Kuzzle instance name [ex: stack-0]"},"all":{"name":"all","type":"boolean","char":"a","description":"Kill all instances","allowNo":false}},"args":[]},"instance:list":{"id":"instance:list","description":"Lists the Kuzzle running instances","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{},"args":[]},"instance:logs":{"id":"instance:logs","description":"Displays the logs of a running Kuzzle","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"instance":{"name":"instance","type":"option","char":"i","description":"Kuzzle instance name"},"follow":{"name":"follow","type":"boolean","char":"f","description":"Follow log output","allowNo":false}},"args":[]},"instance:spawn":{"id":"instance:spawn","description":"Spawn a new Kuzzle instance","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"check":{"name":"check","type":"boolean","description":"Check prerequisite before running Kuzzle","allowNo":false},"version":{"name":"version","type":"option","char":"v","description":"Core-version of the instance to spawn","default":"2"}},"args":[]},"profile:export":{"id":"profile:export","description":"Exports profiles","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"path":{"name":"path","type":"option","description":"Dump directory","default":"profiles"},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or websocket)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[]},"profile:import":{"id":"profile:import","description":"Imports profiles","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or websocket)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"path","description":"Dump file","required":true}]},"realtime:subscribe":{"id":"realtime:subscribe","description":"Subscribes to realtime notifications","pluginName":"kourou","pluginType":"core","aliases":[],"examples":["kourou realtime:subscribe iot-data sensors","kourou realtime:subscribe iot-data sensors '{ range: { temperature: { gt: 0 } } }'","kourou realtime:subscribe iot-data sensors '{ exists: \"position\" }' --scope out","kourou realtime:subscribe iot-data sensors --users all --volatile '{ clientId: \"citizen-kane\" }'","kourou realtime:subscribe iot-data sensors --display result._source.temperature"],"flags":{"scope":{"name":"scope","type":"option","description":"Subscribe to document entering or leaving the scope (all, in, out, none)","default":"all"},"users":{"name":"users","type":"option","description":"Subscribe to users entering or leaving the room (all, in, out, none)","default":"all"},"volatile":{"name":"volatile","type":"option","description":"Additional subscription information used in user join/leave notifications","default":"{}"},"display":{"name":"display","type":"option","description":"Path of the property to display from the notification (empty string to display everything)","default":"result"},"editor":{"name":"editor","type":"boolean","description":"Open an editor (EDITOR env variable) to edit the filters before subscribing.","allowNo":false},"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (only websocket for realtime)","default":"websocket"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"index","description":"Index name","required":true},{"name":"collection","description":"Collection name","required":true},{"name":"filters","description":"Set of Koncorde filters"}]},"redis:list-keys":{"id":"redis:list-keys","description":"Lists keys stored in Redis","pluginName":"kourou","pluginType":"core","aliases":[],"examples":["kourou redis:list-keys \"*cluster*\"","kourou redis:list-keys \"counters/*\" --remove"],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"remove":{"name":"remove","type":"boolean","description":"Remove matching keys","allowNo":false},"size":{"name":"size","type":"option","description":"Page size","default":"100"},"max":{"name":"max","type":"option","description":"Maximum number of page to retrieve (-1 to retrieve everything)","default":"-1"},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or ws)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"match","description":"Match Redis keys with a pattern","default":"*"}]},"role:export":{"id":"role:export","description":"Exports roles","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"path":{"name":"path","type":"option","description":"Dump directory","default":"roles"},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or websocket)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[]},"role:import":{"id":"role:import","description":"Import roles","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"preserve-anonymous":{"name":"preserve-anonymous","type":"boolean","description":"Preserve anonymous rights","allowNo":false},"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or websocket)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"path","description":"Dump file","required":true}]},"sdk:execute":{"id":"sdk:execute","description":"\nExecutes arbitrary code.\n\nCode Execution\n\n  Provided code will be executed in an async method.\n  You can access a connected and authenticated SDK with the \"sdk\" variable.\n  Templated variable passed as the command arguments are also accessible within the same name.\n  Returned value will be printed on the standard output (e.g. 'return await sdk.server.now();').\n  Errors will be caught and printed on the error output (e.g. 'throw new Error(\"failure\");').\n\nProvide code\n\n  code can be passed as an argument\n  code will be read from STDIN if available\n\n  Examples:\n    - kourou sdk:execute 'return await sdk.server.now()'\n    - kourou sdk:execute 'return await sdk.index.exists(index)' --var 'index=\"iot-data\"'\n    - kourou sdk:execute < snippet.js\n    - echo 'return await sdk.server.now()' | kourou sdk:execute\n\nOther\n\n  use the --editor flag to modify the code before executing it\n\n  Examples:\n    - kourou sdk:execute 'return await sdk.server.now()' --editor\n","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"var":{"name":"var","type":"option","char":"v","description":"Additional arguments injected into the code. (eg: --var 'index=\"iot-data\"'"},"editor":{"name":"editor","type":"boolean","description":"Open an editor (EDITOR env variable) to edit the code before executing it.","allowNo":false},"keep-alive":{"name":"keep-alive","type":"boolean","description":"Keep the connection running (websocket only)","allowNo":false},"print-raw":{"name":"print-raw","type":"boolean","description":"Print only the script result to stdout","allowNo":false},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or ws)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"code","description":"Code to execute. Will be read from STDIN if available.","required":false}]},"sdk:query":{"id":"sdk:query","description":"\nExecutes an API query.\n\nQuery arguments\n\n  Arguments can be passed and repeated using the --arg or -a flag.\n  Index and collection names can be passed with --index (-i) and --collection (-c) flags\n  ID can be passed with the --id flag.\n\n  Examples:\n    - kourou sdk:query document:delete -i iot -c sensors -a refresh=wait_for\n\nQuery body\n\n  Body can be passed with the --body flag with either a JSON or JS string.\n  Body will be read from STDIN if available\n\n  Examples:\n    - kourou sdk:query document:create -i iot -c sensors --body '{creation: Date.now())}'\n    - kourou sdk:query admin:loadMappings < mappings.json\n    - echo '{dynamic: \"strict\"}' | kourou sdk:query collection:create -i iot -c sensors\n\nOther\n\n  Use the --editor flag to modify the query before sending it to Kuzzle\n  Use the --display flag to display a specific property of the response\n\n  Examples:\n    - kourou sdk:query document:create -i iot -c sensors --editor\n    - kourou sdk:query server:now --display 'result.now'\n\nDefault fallback to API action\n\n  It's possible to use the \"sdk:query\" command by only specifying the corresponding controller\n  and action as first argument.\n\n  Kourou will try to infer the first arguments to one the following pattern:\n    - <command> <index>\n    - <command> <body>\n    - <command> <index> <collection>\n    - <command> <index> <collection> <id>\n    - <command> <index> <collection> <body>\n    - <command> <index> <collection> <id> <body>\n\n  If a flag is given (-i, -c, --body or --id), then the flag value has priority over\n  argument infering.\n\n  Examples:\n    - kourou collection:list iot\n    - kourou security:createUser '{ \"content\": { \"profileIds\": [\"default\"] } }' --id yagmur\n    - kourou collection:delete iot sensors\n    - kourou document:createOrReplace iot sensors sigfox-1 '{}'\n    - kourou bulk:import iot sensors '{ bulkData: [...] }'\n    - kourou admin:loadMappings < mappings.json\n","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"arg":{"name":"arg","type":"option","char":"a","description":"Additional argument. Repeatable. (e.g. \"-a refresh=wait_for\")"},"body":{"name":"body","type":"option","description":"Request body in JS or JSON format. Will be read from STDIN if available.","default":"{}"},"editor":{"name":"editor","type":"boolean","description":"Open an editor (EDITOR env variable) to edit the request before sending.","allowNo":false},"body-editor":{"name":"body-editor","type":"boolean","description":"Open an editor (EDITOR env variable) to edit the body before sending.","allowNo":false},"index":{"name":"index","type":"option","char":"i","description":"Index argument"},"collection":{"name":"collection","type":"option","char":"c","description":"Collection argument"},"id":{"name":"id","type":"option","description":"ID argument (_id)"},"display":{"name":"display","type":"option","description":"Path of the property to display from the response (empty string to display the result)","default":"result"},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or ws)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"controller:action","description":"Controller and action (eg: \"server:now\")","required":true}]},"user:export-mappings":{"id":"user:export-mappings","description":"Exports users collection mappings to JSON.","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"path":{"name":"path","type":"option","description":"Dump directory","default":"users"},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or websocket)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[]},"user:export":{"id":"user:export","description":"\nExports users to JSON.\n\nThe users will be exported WITHOUT their credentials since Kuzzzle can't access them.\n\nYou can either:\n  - Manually re-create credentials for your users\n  - Use the \"mustChangePasswordIfSetByAdmin\" option Kuzzle password policies (see https://github.com/kuzzleio/kuzzle-plugin-auth-passport-local/#optional-properties)\n  - Use the \"--generate-credentials\" flag to auto-generate credentials for your users\n\nAuto-generation of credentials\n\n  With the \"--generate-credentials\" flag, Kourou will add credentials for the \"local\" strategy.\n  By default, the username will be the user ID.\n  Use the \"generated-username\" flag to use an other property than the user ID for the generated username\n  The password will be a strong random 40 characters string\n\nExamples:\n\n  - kourou user:export\n  - kourou user:export --exclude '.*admin.*' --exclude 'supervisor.*'\n  - kourou user:export --generate-credentials\n  - kourou user:export --generate-credentials --generated-username content.email\n","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"path":{"name":"path","type":"option","description":"Dump directory","default":"users"},"exclude":{"name":"exclude","type":"option","description":"Exclude users by matching their IDs with a regexp"},"generate-credentials":{"name":"generate-credentials","type":"boolean","description":"Generate credentials with a random password for users","allowNo":false},"generated-username":{"name":"generated-username","type":"option","description":"User content property used as a username for local credentials","default":"_id"},"batch-size":{"name":"batch-size","type":"option","description":"Maximum batch size (see limits.documentsFetchCount config)","default":"2000"},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or websocket)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[]},"user:import-mappings":{"id":"user:import-mappings","description":"Imports users collection mappings","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or websocket)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"path","description":"Dump file","required":true}]},"user:import":{"id":"user:import","description":"Imports users","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"host":{"name":"host","type":"option","description":"Kuzzle server host","default":"localhost"},"port":{"name":"port","type":"option","description":"Kuzzle server port","default":"7512"},"ssl":{"name":"ssl","type":"boolean","description":"Use SSL to connect to Kuzzle","allowNo":false},"username":{"name":"username","type":"option","description":"Kuzzle username (local strategy)","default":"anonymous"},"password":{"name":"password","type":"option","description":"Kuzzle user password"},"protocol":{"name":"protocol","type":"option","description":"Kuzzle protocol (http or websocket)","default":"ws"},"as":{"name":"as","type":"option","description":"Impersonate a user"},"api-key":{"name":"api-key","type":"option","description":"Kuzzle user api-key"}},"args":[{"name":"path","description":"Dump file","required":true}]},"vault:add":{"id":"vault:add","description":"\nAdds an encrypted key to an encrypted secrets file.\n\nA new secrets file is created if it does not yet exist.\n\nEncrypted secrets are meant to be loaded inside an application with Kuzzle Vault.\n\nSee https://github.com/kuzzleio/kuzzle-vault/ for more information.\n","pluginName":"kourou","pluginType":"core","aliases":[],"examples":["kourou vault:add config/secrets.enc.json aws.s3.keyId b61e267676660c314b006b06 --vault-key <vault-key>"],"flags":{"vault-key":{"name":"vault-key","type":"option","description":"Kuzzle Vault Key (or KUZZLE_VAULT_KEY)"}},"args":[{"name":"secrets-file","description":"Encrypted secrets file","required":true},{"name":"key","description":"Path to the key (lodash style)","required":true},{"name":"value","description":"Value to encrypt","required":true}]},"vault:decrypt":{"id":"vault:decrypt","description":"\nDecrypts an entire secrets file.\n\nDecrypted secrets file must NEVER be committed into the repository.\n\nSee https://github.com/kuzzleio/kuzzle-vault/ for more information.\n","pluginName":"kourou","pluginType":"core","aliases":[],"examples":["kourou vault:decrypt config/secrets.enc.json --vault-key <vault-key>","kourou vault:decrypt config/secrets.enc.json -o config/secrets.json --vault-key <vault-key>"],"flags":{"force":{"name":"force","type":"boolean","char":"f","description":"Overwrite the output file if it already exists","allowNo":false},"output-file":{"name":"output-file","type":"option","char":"o","description":"Output file (default: remove \".enc\")"},"vault-key":{"name":"vault-key","type":"option","description":"Kuzzle Vault Key (or KUZZLE_VAULT_KEY)"}},"args":[{"name":"file","description":"File containing encrypted secrets","required":true}]},"vault:encrypt":{"id":"vault:encrypt","description":"\nEncrypts an entire secrets file.\n\nThe secrets file must be in JSON format and it must contain only strings or objects.\n\nExample:\n{\n  aws: {\n    s3: {\n      keyId: 'b61e267676660c314b006b06'\n    }\n  }\n}\n\nEncrypted secrets are meant to be loaded inside an application with Kuzzle Vault.\n\nSee https://github.com/kuzzleio/kuzzle-vault/ for more information.\n","pluginName":"kourou","pluginType":"core","aliases":[],"examples":["kourou vault:encrypt config/secrets.json --vault-key <vault-key>","kourou vault:encrypt config/secrets.json -o config/secrets_prod.enc.json --vault-key <vault-key>"],"flags":{"force":{"name":"force","type":"boolean","char":"f","description":"Overwrite the output file if it already exists","allowNo":false},"output-file":{"name":"output-file","type":"option","char":"o","description":"Output file (default: <file>.enc.json)"},"vault-key":{"name":"vault-key","type":"option","description":"Kuzzle Vault Key (or KUZZLE_VAULT_KEY)"}},"args":[{"name":"file","description":"File containing unencrypted secrets","required":true}]},"vault:show":{"id":"vault:show","description":"\nPrints an encrypted secrets file content.\n\nThis method can display either:\n - the entire content of the secrets file\n - a single key value\n\nSee https://github.com/kuzzleio/kuzzle-vault/ for more information.\n","pluginName":"kourou","pluginType":"core","aliases":[],"examples":["kourou vault:show config/secrets.enc.json --vault-key <vault-key>","kourou vault:show config/secrets.enc.json aws.s3.secretKey --vault-key <vault-key>"],"flags":{"vault-key":{"name":"vault-key","type":"option","description":"Kuzzle Vault Key (or KUZZLE_VAULT_KEY)"}},"args":[{"name":"secrets-file","description":"Encrypted secrets file","required":true},{"name":"key","description":"Path to a key (lodash style)"}]},"vault:test":{"id":"vault:test","description":"\nTests if an encrypted secrets file can be decrypted.\n\nSee https://github.com/kuzzleio/kuzzle-vault/ for more information.\n","pluginName":"kourou","pluginType":"core","aliases":[],"examples":["kourou vault:test config/secrets.enc.json --vault-key <vault-key>"],"flags":{"vault-key":{"name":"vault-key","type":"option","description":"Kuzzle Vault Key (or KUZZLE_VAULT_KEY)"}},"args":[{"name":"secrets-file","description":"Encrypted secrets file","required":true}]},"es:indices:cat":{"id":"es:indices:cat","description":"Lists available ES indexes","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"node":{"name":"node","type":"option","char":"n","description":"Elasticsearch server URL","default":"http://localhost:9200"},"grep":{"name":"grep","type":"option","char":"g","description":"Match output with pattern"}},"args":[]},"es:indices:get":{"id":"es:indices:get","description":"Gets a document from ES","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false},"node":{"name":"node","type":"option","char":"n","description":"Elasticsearch server URL","default":"http://localhost:9200"}},"args":[{"name":"index","description":"ES Index name","required":true},{"name":"id","description":"Document ID","required":true}]},"es:indices:insert":{"id":"es:indices:insert","description":"Inserts a document directly into ES (will replace if exists)","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"body":{"name":"body","type":"option","description":"Document body in JSON","default":"{}"},"id":{"name":"id","type":"option","description":"Document ID"},"node":{"name":"node","type":"option","char":"n","description":"Elasticsearch server URL","default":"http://localhost:9200"},"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false}},"args":[{"name":"index","description":"ES Index name","required":true}]},"es:snapshot:create-repository":{"id":"es:snapshot:create-repository","description":"Create a FS snapshot repository inside an ES instance","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"compress":{"name":"compress","type":"boolean","description":"Compress data when storing them","allowNo":false},"node":{"name":"node","type":"option","char":"n","description":"Elasticsearch server URL","default":"http://localhost:9200"},"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false}},"args":[{"name":"repository","description":"ES repository name","required":true},{"name":"location","description":"ES snapshot repository location","required":true}]},"es:snapshot:create":{"id":"es:snapshot:create","description":"Create a snapshot repository inside an ES instance","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"node":{"name":"node","type":"option","char":"n","description":"Elasticsearch server URL","default":"http://localhost:9200"},"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false}},"args":[{"name":"repository","description":"ES repository name","required":true},{"name":"name","description":"ES snapshot name","required":true}]},"es:snapshot:list":{"id":"es:snapshot:list","description":"List all snapshot from a repository acknowledge by an ES instance","pluginName":"kourou","pluginType":"core","aliases":[],"flags":{"node":{"name":"node","type":"option","char":"n","description":"Elasticsearch server URL","default":"http://localhost:9200"},"help":{"name":"help","type":"boolean","description":"show CLI help","allowNo":false}},"args":[{"name":"repository","description":"Name of repository from which to fetch the snapshot information","required":true}]}}}

package/package.json

@@ -1,18 +1,31 @@
 {
   "name": "kourou",
   "description": "The CLI that helps you manage your Kuzzle instances",
-  "version": "0.19.4",
+  "version": "0.19.5",
   "author": "The Kuzzle Team <support@kuzzle.io>",
   "bin": {
     "kourou": "./bin/run"
   },
   "bugs": "https://github.com/kuzzleio/kourou/issues",
+  "scripts": {
+    "build": "tsc -b",
+    "dev": "./bin/run",
+    "postpack": "rm -f oclif.manifest.json",
+    "prepack": "tar czf templates.tgz templates/ && rm -rf lib && tsc -b && oclif-dev manifest && oclif-dev readme",
+    "postinstall": "[ -f templates.tgz ] && tar xf templates.tgz || true",
+    "version": "oclif-dev readme && git add README.md",
+    "test:lint": "eslint src/ test/ --ext .ts",
+    "test:lint:fix": "eslint src/ test/ --ext .ts --fix",
+    "test:functional": "npm run build && npm run test:functional:stdout && npm run test:functional:cucumber",
+    "test:functional:stdout": "nyc --extension .ts mocha --forbid-only \"test/**/*.test.ts\"",
+    "test:functional:cucumber": "./node_modules/.bin/cucumber-js --fail-fast"
+  },
   "dependencies": {
     "@elastic/elasticsearch": "^7.12.0",
     "@oclif/command": "^1.8.0",
     "@oclif/config": "^1.17.0",
     "@oclif/plugin-autocomplete": "^0.3.0",
-    "@oclif/plugin-help": "^3.2.2",
+    "@oclif/plugin-help": "3.2.2",
     "@types/bluebird": "^3.5.33",
     "@types/inquirer": "^7.3.1",
     "@types/ndjson": "^2.0.0",
@@ -122,18 +135,5 @@
     }
   },
   "repository": "kuzzleio/kourou",
-  "scripts": {
-    "build": "tsc -b",
-    "dev": "./bin/run",
-    "postpack": "rm -f oclif.manifest.json",
-    "prepack": "tar czf templates.tgz templates/ && rm -rf lib && tsc -b && oclif-dev manifest && oclif-dev readme",
-    "postinstall": "[ -f templates.tgz ] && tar xf templates.tgz || true",
-    "version": "oclif-dev readme && git add README.md",
-    "test:lint": "eslint src/ test/ --ext .ts",
-    "test:lint:fix": "eslint src/ test/ --ext .ts --fix",
-    "test:functional": "npm run build && npm run test:functional:stdout && npm run test:functional:cucumber",
-    "test:functional:stdout": "nyc --extension .ts mocha --forbid-only \"test/**/*.test.ts\"",
-    "test:functional:cucumber": "./node_modules/.bin/cucumber-js"
-  },
   "types": "lib/index.d.ts"
 }

package/lib/commands/es/snapshot/restore.d.ts

@@ -1,18 +0,0 @@
-import { flags } from '@oclif/command';
-import { Client } from '@elastic/elasticsearch';
-import { Kommand } from '../../../common';
-export default class ESRestore extends Kommand {
-    static initSdk: boolean;
-    static description: string;
-    static flags: {
-        node: flags.IOptionFlag<string>;
-        help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
-    };
-    static args: {
-        name: string;
-        description: string;
-        required: boolean;
-    }[];
-    getIndices(esClient: Client): Promise<any>;
-    runSafe(): Promise<void>;
-}

package/lib/commands/es/snapshot/restore.js

@@ -1,52 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const command_1 = require("@oclif/command");
-const elasticsearch_1 = require("@elastic/elasticsearch");
-const common_1 = require("../../../common");
-class ESRestore extends common_1.Kommand {
-    async getIndices(esClient) {
-        const beforeResponse = await esClient.cat.indices({ format: 'json' });
-        const indices = beforeResponse.body
-            .map(({ index }) => index);
-        return indices;
-    }
-    async runSafe() {
-        const esClient = new elasticsearch_1.Client({ node: this.flags.node });
-        const indices = await this.getIndices(esClient);
-        try {
-            for (const index of indices) {
-                await esClient.indices.close({ index });
-            }
-            const esRequest = {
-                repository: this.args.repository,
-                snapshot: this.args.name,
-                body: {}
-            };
-            const response = await esClient.snapshot.restore(esRequest);
-            this.logOk(`Success ${JSON.stringify(response.body, null, 2)}`);
-        }
-        catch (error) {
-            this.logKo(`Failed to restore requested snapshot ${this.args.name}`);
-        }
-        finally {
-            for (const index of indices) {
-                await esClient.indices.open({ index });
-            }
-        }
-    }
-}
-exports.default = ESRestore;
-ESRestore.initSdk = false;
-ESRestore.description = 'Restore a snapshot into an ES instance';
-ESRestore.flags = {
-    node: command_1.flags.string({
-        char: 'n',
-        description: 'Elasticsearch server URL',
-        default: 'http://localhost:9200',
-    }),
-    help: command_1.flags.help(),
-};
-ESRestore.args = [
-    { name: 'repository', description: 'ES repository name', required: true },
-    { name: 'name', description: 'ES snapshot name', required: true },
-];