kourou 0.24.1 → 0.25.0

package/README.md

@@ -26,7 +26,7 @@ $ npm install -g kourou
 $ kourou COMMAND
 running command...
 $ kourou (-v|--version|version)
-kourou/0.24.1 linux-x64 node-v16.13.2
+kourou/0.25.0 linux-x64 node-v16.15.0
 $ kourou --help [COMMAND]
 USAGE
   $ kourou COMMAND
@@ -130,14 +130,17 @@ All other arguments and options will be passed as-is to the `sdk:query` method.
 * [`kourou api-key:delete USER ID`](#kourou-api-keydelete-user-id)
 * [`kourou api-key:search USER`](#kourou-api-keysearch-user)
 * [`kourou app:debug-proxy`](#kourou-appdebug-proxy)
+* [`kourou app:doctor`](#kourou-appdoctor)
 * [`kourou app:scaffold DESTINATION`](#kourou-appscaffold-destination)
 * [`kourou app:start-services`](#kourou-appstart-services)
 * [`kourou autocomplete [SHELL]`](#kourou-autocomplete-shell)
 * [`kourou collection:create INDEX COLLECTION [BODY]`](#kourou-collectioncreate-index-collection-body)
 * [`kourou collection:export INDEX COLLECTION`](#kourou-collectionexport-index-collection)
 * [`kourou collection:import PATH`](#kourou-collectionimport-path)
+* [`kourou collection:migrate SCRIPT PATH`](#kourou-collectionmigrate-script-path)
 * [`kourou config:diff FIRST SECOND`](#kourou-configdiff-first-second)
 * [`kourou document:search INDEX COLLECTION [QUERY]`](#kourou-documentsearch-index-collection-query)
+* [`kourou es:aliases:cat`](#kourou-esaliasescat)
 * [`kourou es:indices:cat`](#kourou-esindicescat)
 * [`kourou es:indices:get INDEX ID`](#kourou-esindicesget-index-id)
 * [`kourou es:indices:insert INDEX`](#kourou-esindicesinsert-index)
@@ -327,6 +330,29 @@ OPTIONS
 
 _See code: [src/commands/app/debug-proxy.ts](src/commands/app/debug-proxy.ts)_
 
+## `kourou app:doctor`
+
+Analyze a Kuzzle application
+
+```
+USAGE
+  $ kourou app:doctor
+
+OPTIONS
+  --api-key=api-key              Kuzzle user api-key
+  --as=as                        Impersonate a user
+  --elasticsearch=elasticsearch  [default: http://localhost:9200] Elasticsearch server URL
+  --help                         show CLI help
+  --host=host                    [default: localhost] Kuzzle server host
+  --password=password            Kuzzle user password
+  --port=port                    [default: 7512] Kuzzle server port
+  --protocol=protocol            [default: ws] Kuzzle protocol (http or ws)
+  --ssl                          Use SSL to connect to Kuzzle
+  --username=username            [default: anonymous] Kuzzle username (local strategy)
+```
+
+_See code: [src/commands/app/doctor.ts](src/commands/app/doctor.ts)_
+
 ## `kourou app:scaffold DESTINATION`
 
 Scaffolds a new Kuzzle application
@@ -339,7 +365,9 @@ ARGUMENTS
   DESTINATION  Directory to scaffold the app
 
 OPTIONS
-  --flavor=flavor  [default: generic] Template flavor ("generic", "iot-platform")
+  --flavor=flavor  [default: generic] Template flavor ("generic", "iot-platform", "iot-console", "iot-platform").
+                   Those can be found here: https://github.com/kuzzleio/project-templates
+
   --help           show CLI help
 ```
 
@@ -381,7 +409,7 @@ EXAMPLES
   $ kourou autocomplete --refresh-cache
 ```
 
-_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v1.2.0/src/commands/autocomplete/index.ts)_
+_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v1.3.10/src/commands/autocomplete/index.ts)_
 
 ## `kourou collection:create INDEX COLLECTION [BODY]`
 
@@ -471,7 +499,8 @@ OPTIONS
       [default: {}] Only dump documents matching the query (JS or JSON format)
 
   --scrollTTL=scrollTTL
-      The scroll TTL option to pass to the dump operation (which performs a document.search under the hood),
+      [default: 20s] The scroll TTL option to pass to the dump operation (which performs a document.search under the
+      hood),
       expressed in ms format, e.g. '2s', '1m', '3h'.
 
   --ssl
@@ -516,6 +545,35 @@ OPTIONS
 
 _See code: [src/commands/collection/import.ts](src/commands/collection/import.ts)_
 
+## `kourou collection:migrate SCRIPT PATH`
+
+Migrate a collection
+
+```
+USAGE
+  $ kourou collection:migrate SCRIPT PATH
+
+ARGUMENTS
+  SCRIPT  Migration script path
+  PATH    Collection dump path
+
+OPTIONS
+  --api-key=api-key        Kuzzle user api-key
+  --as=as                  Impersonate a user
+  --batch-size=batch-size  [default: 200] Maximum batch size (see limits.documentsWriteCount config)
+  --collection=collection  If set, override the collection destination name
+  --help                   show CLI help
+  --host=host              [default: localhost] Kuzzle server host
+  --index=index            If set, override the index destination name
+  --password=password      Kuzzle user password
+  --port=port              [default: 7512] Kuzzle server port
+  --protocol=protocol      [default: ws] Kuzzle protocol (http or websocket)
+  --ssl                    Use SSL to connect to Kuzzle
+  --username=username      [default: anonymous] Kuzzle username (local strategy)
+```
+
+_See code: [src/commands/collection/migrate.ts](src/commands/collection/migrate.ts)_
+
 ## `kourou config:diff FIRST SECOND`
 
 Returns differences between two Kuzzle configuration files (kuzzlerc)
@@ -576,6 +634,22 @@ EXAMPLES
 
 _See code: [src/commands/document/search.ts](src/commands/document/search.ts)_
 
+## `kourou es:aliases:cat`
+
+Lists available ES aliases
+
+```
+USAGE
+  $ kourou es:aliases:cat
+
+OPTIONS
+  -g, --grep=grep  Match output with pattern
+  -n, --node=node  [default: http://localhost:9200] Elasticsearch server URL
+  --help           show CLI help
+```
+
+_See code: [src/commands/es/aliases/cat.ts](src/commands/es/aliases/cat.ts)_
+
 ## `kourou es:indices:cat`
 
 Lists available ES indexes
@@ -633,7 +707,7 @@ _See code: [src/commands/es/indices/insert.ts](src/commands/es/indices/insert.ts
 
 ## `kourou es:migrate`
 
-Migrate all the index from one Elasticsearch server to another
+Migrate all the index from an Elasticsearch (or a file) to another Elasticsearch
 
 ```
 USAGE
@@ -641,19 +715,19 @@ USAGE
 
 OPTIONS
   --batch-size=batch-size  [default: 1000] How many documents to move in batch per operation
-  --dest=dest              (required) Destination Elasticsearch server URL
+  --dest=dest              (required) Migration destination provider
   --dry-run                Print witch collections will be migrated
   --help                   show CLI help
   --no-interactive         Skip confirmation interactive prompts (perfect for scripting)
   --pattern=pattern        Pattern to match indices to migrate
   --reset                  Reset destination Elasticsearch server
   --scroll=scroll          [default: 30s] Scroll duration for Elasticsearch scrolling
-  --src=src                (required) Source Elasticsearch server URL
+  --src=src                (required) Migration source provider
 
 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
+  kourou es:migrate --src http://elasticsearch:9200 --dest ./my-backup --batch-size 2000 --pattern 
+  '&myindexes.collection-*'
+  kourou es:migrate --src ./my-backup --dest http://elasticsearch:9200 --reset --batch-size 2000 --no-interactive
 ```
 
 _See code: [src/commands/es/migrate.ts](src/commands/es/migrate.ts)_
@@ -796,7 +870,7 @@ OPTIONS
   --all  see all commands in CLI
 ```
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.2/src/commands/help.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.18/src/commands/help.ts)_
 
 ## `kourou import PATH`
 
@@ -858,6 +932,10 @@ OPTIONS
 
   --query=query            [default: {}] Only dump documents in collections matching the query (JS or JSON format)
 
+  --scrollTTL=scrollTTL    [default: 20s] The scroll TTL option to pass to the dump operation (which performs a
+                           document.search under the hood),
+                           expressed in ms format, e.g. '2s', '1m', '3h'.
+
   --ssl                    Use SSL to connect to Kuzzle
 
   --username=username      [default: anonymous] Kuzzle username (local strategy)
@@ -1006,6 +1084,7 @@ USAGE
 
 OPTIONS
   --help               show CLI help
+  --only_npm           Only perform the login on the private NPM registry
   --project=project    Current PaaS project
   --username=username  PaaS username
 ```
@@ -1025,8 +1104,14 @@ ARGUMENTS
   APPLICATION  Kuzzle PaaS application
 
 OPTIONS
+  -f, --follow       Follow log output
+  -n, --tail=tail    Number of lines to show from the end of the logs
+  -t, --timestamp    Show timestamp
   --help             show CLI help
+  --podName=podName  Name of the pod to show logs from
   --project=project  Current PaaS project
+  --since=since      Display logs from a specific absolute (e.g. 2022/12/02 09:41) or relative (e.g. a minute ago) time
+  --until=until      Display logs until a specific absolute (e.g. 2022/12/02 09:41) or relative (e.g. a minute ago) time
 ```
 
 _See code: [src/commands/paas/logs.ts](src/commands/paas/logs.ts)_
@@ -1305,6 +1390,8 @@ OPTIONS
 
   --port=port                  [default: 7512] Kuzzle server port
 
+  --print-raw                  Print only the query result to stdout
+
   --protocol=protocol          [default: ws] Kuzzle protocol (http or ws)
 
   --ssl                        Use SSL to connect to Kuzzle
@@ -1677,7 +1764,7 @@ $ kourou sdk:execute --print-raw '(
 
 # Telemetry
 
-We use a custom Open Source analytics backend (you can check the code [here](https://gihtub.com/kuzzleio/kepler)) to record the use of Kourou by users.
+We use a custom Open Source analytics backend (you can check the code [here](https://github.com/kuzzleio/kepler)) to record the use of Kourou by users.
 
 Collected metrics will allow us to study the use of our products in order to improve them. We do not collect any personal data about users.
 

package/lib/commands/api-key/check.d.ts

@@ -1,5 +1,5 @@
-import { flags } from '@oclif/command';
-import { Kommand } from '../../common';
+import { flags } from "@oclif/command";
+import { Kommand } from "../../common";
 declare class ApiKeyCheck extends Kommand {
     static description: string;
     static flags: {
@@ -10,7 +10,7 @@ declare class ApiKeyCheck extends Kommand {
         password: flags.IOptionFlag<string | undefined>;
         protocol: flags.IOptionFlag<string>;
         as: flags.IOptionFlag<string | undefined>;
-        'api-key': flags.IOptionFlag<string | undefined>;
+        "api-key": flags.IOptionFlag<string | undefined>;
         help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
     };
     static args: {

package/lib/commands/api-key/check.js

@@ -7,19 +7,17 @@ class ApiKeyCheck extends common_1.Kommand {
     async runSafe() {
         const { valid } = await this.sdk.auth.checkToken(this.args.token);
         if (valid) {
-            this.logOk('API key is still valid');
+            this.logOk("API key is still valid");
         }
         else {
-            this.logKo('API key is not valid');
+            this.logKo("API key is not valid");
         }
     }
 }
-ApiKeyCheck.description = 'Checks an API key validity';
+ApiKeyCheck.description = "Checks an API key validity";
 ApiKeyCheck.flags = Object.assign({ help: command_1.flags.help() }, kuzzle_1.kuzzleFlags);
 ApiKeyCheck.args = [
-    { name: 'token', description: 'API key token', required: true },
-];
-ApiKeyCheck.examples = [
-    'kourou api-key:check eyJhbG...QxfQrc'
+    { name: "token", description: "API key token", required: true },
 ];
+ApiKeyCheck.examples = ["kourou api-key:check eyJhbG...QxfQrc"];
 exports.default = ApiKeyCheck;

package/lib/commands/api-key/create.d.ts

@@ -1,5 +1,5 @@
-import { flags } from '@oclif/command';
-import { Kommand } from '../../common';
+import { flags } from "@oclif/command";
+import { Kommand } from "../../common";
 declare class ApiKeyCreate extends Kommand {
     static description: string;
     static flags: {
@@ -10,7 +10,7 @@ declare class ApiKeyCreate extends Kommand {
         password: flags.IOptionFlag<string | undefined>;
         protocol: flags.IOptionFlag<string>;
         as: flags.IOptionFlag<string | undefined>;
-        'api-key': flags.IOptionFlag<string | undefined>;
+        "api-key": flags.IOptionFlag<string | undefined>;
         help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
         description: flags.IOptionFlag<string>;
         id: flags.IOptionFlag<string | undefined>;

package/lib/commands/api-key/create.js

@@ -7,24 +7,22 @@ class ApiKeyCreate extends common_1.Kommand {
     async runSafe() {
         const apiKey = await this.sdk.security.createApiKey(this.args.user, this.flags.description, {
             _id: this.flags.id,
-            expiresIn: this.flags.expire
+            expiresIn: this.flags.expire,
         });
         this.logOk(`Successfully created API Key "${apiKey._id}" for user "${this.args.user}"`);
         this.log(apiKey._source.token);
     }
 }
-ApiKeyCreate.description = 'Creates a new API Key for a user';
+ApiKeyCreate.description = "Creates a new API Key for a user";
 ApiKeyCreate.flags = Object.assign({ help: command_1.flags.help(), description: command_1.flags.string({
-        char: 'd',
-        description: 'API Key description',
+        char: "d",
+        description: "API Key description",
         required: true,
     }), id: command_1.flags.string({
-        description: 'API Key unique ID',
+        description: "API Key unique ID",
     }), expire: command_1.flags.string({
-        description: 'API Key validity',
-        default: '-1',
+        description: "API Key validity",
+        default: "-1",
     }) }, kuzzle_1.kuzzleFlags);
-ApiKeyCreate.args = [
-    { name: 'user', description: 'User kuid', required: true },
-];
+ApiKeyCreate.args = [{ name: "user", description: "User kuid", required: true }];
 exports.default = ApiKeyCreate;

package/lib/commands/api-key/delete.d.ts

@@ -1,5 +1,5 @@
-import { flags } from '@oclif/command';
-import { Kommand } from '../../common';
+import { flags } from "@oclif/command";
+import { Kommand } from "../../common";
 declare class ApiKeyDelete extends Kommand {
     static description: string;
     static flags: {
@@ -10,7 +10,7 @@ declare class ApiKeyDelete extends Kommand {
         password: flags.IOptionFlag<string | undefined>;
         protocol: flags.IOptionFlag<string>;
         as: flags.IOptionFlag<string | undefined>;
-        'api-key': flags.IOptionFlag<string | undefined>;
+        "api-key": flags.IOptionFlag<string | undefined>;
         help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
     };
     static args: {

package/lib/commands/api-key/delete.js

@@ -9,13 +9,11 @@ class ApiKeyDelete extends common_1.Kommand {
         this.logOk(`Successfully deleted API Key "${this.args.id}" of user "${this.args.user}"`);
     }
 }
-ApiKeyDelete.description = 'Deletes an API key.';
+ApiKeyDelete.description = "Deletes an API key.";
 ApiKeyDelete.flags = Object.assign({ help: command_1.flags.help() }, kuzzle_1.kuzzleFlags);
 ApiKeyDelete.args = [
-    { name: 'user', description: 'User kuid', required: true },
-    { name: 'id', description: 'API Key unique ID', required: true },
-];
-ApiKeyDelete.examples = [
-    'kourou vault:delete sigfox-gateway 1k-BF3EBjsXdvA2PR8x'
+    { name: "user", description: "User kuid", required: true },
+    { name: "id", description: "API Key unique ID", required: true },
 ];
+ApiKeyDelete.examples = ["kourou vault:delete sigfox-gateway 1k-BF3EBjsXdvA2PR8x"];
 exports.default = ApiKeyDelete;

package/lib/commands/api-key/search.d.ts

@@ -1,5 +1,5 @@
-import { flags } from '@oclif/command';
-import { Kommand } from '../../common';
+import { flags } from "@oclif/command";
+import { Kommand } from "../../common";
 declare class ApiKeySearch extends Kommand {
     static description: string;
     static flags: {
@@ -10,7 +10,7 @@ declare class ApiKeySearch extends Kommand {
         password: flags.IOptionFlag<string | undefined>;
         protocol: flags.IOptionFlag<string>;
         as: flags.IOptionFlag<string | undefined>;
-        'api-key': flags.IOptionFlag<string | undefined>;
+        "api-key": flags.IOptionFlag<string | undefined>;
         help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
         filter: flags.IOptionFlag<string | undefined>;
     };

package/lib/commands/api-key/search.js

@@ -15,11 +15,11 @@ class ApiKeySearch extends common_1.Kommand {
         }
         const result = await this.sdk.security.searchApiKeys(this.args.user, query, {
             from: 0,
-            size: 100
+            size: 100,
         });
         this.logOk(`${result.total} API Keys found for user ${this.args.user}`);
         if (result.total !== 0) {
-            this.log('');
+            this.log("");
             for (const { _id, _source } of result.hits) {
                 this.log(` - Key "${_id}"`);
                 this.log(`    Description: ${_source.description}`);
@@ -29,11 +29,9 @@ class ApiKeySearch extends common_1.Kommand {
         }
     }
 }
-ApiKeySearch.description = 'Lists a user\'s API Keys.';
+ApiKeySearch.description = "Lists a user's API Keys.";
 ApiKeySearch.flags = Object.assign({ help: command_1.flags.help(), filter: command_1.flags.string({
-        description: 'Filter to match the API Key descriptions',
+        description: "Filter to match the API Key descriptions",
     }) }, kuzzle_1.kuzzleFlags);
-ApiKeySearch.args = [
-    { name: 'user', description: 'User kuid', required: true },
-];
+ApiKeySearch.args = [{ name: "user", description: "User kuid", required: true }];
 exports.default = ApiKeySearch;

package/lib/commands/app/debug-proxy.d.ts

@@ -1,5 +1,5 @@
-import { flags } from '@oclif/command';
-import { Kommand } from '../../common';
+import { flags } from "@oclif/command";
+import { Kommand } from "../../common";
 export default class DebugProxy extends Kommand {
     static description: string;
     static flags: {
@@ -10,7 +10,7 @@ export default class DebugProxy extends Kommand {
         password: flags.IOptionFlag<string | undefined>;
         protocol: flags.IOptionFlag<string>;
         as: flags.IOptionFlag<string | undefined>;
-        'api-key': flags.IOptionFlag<string | undefined>;
+        "api-key": flags.IOptionFlag<string | undefined>;
         help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
         forwardPort: import("@oclif/parser/lib/flags").IOptionFlag<number>;
         ttl: flags.IOptionFlag<string>;