@meilisearch/cli 0.0.0 → 0.2.0

package/dist/commands/{get/documents.js → document/list.js}

@@ -4,17 +4,17 @@ import { fetchDocuments } from "../../lib/clients/meilisearch.js";
 import { MeiliCliError } from "../../lib/errors.js";
 import { isJsonObject, readJsonBody } from "../../lib/input.js";
 import { nextOffsetQuery } from "../../lib/pagination.js";
-export default class GetDocuments extends BaseCommand {
+export default class DocumentList extends BaseCommand {
     static api = "meilisearch";
     static routes = ["POST /indexes/{index_uid}/documents/fetch"];
     static keyActions = ["documents.get"];
-    static description = "List the documents of an index, narrowed by --ids or by --filter.";
+    static description = `List the documents of an index.
+
+--ids or --filter narrow the list.`;
     static examples = [
         "<%= config.bin %> <%= command.id %> --project prod --index movies",
-        "<%= config.bin %> <%= command.id %> --project prod --index movies --output json",
         "<%= config.bin %> <%= command.id %> --project prod --index movies --ids 42,1344 --fields id,title",
         "<%= config.bin %> <%= command.id %> --project prod --index movies --filter 'rating > 4' --sort rating:desc",
-        "<%= config.bin %> <%= command.id %> --project prod --index movies --all --output ndjson",
     ];
     static flags = {
         ...BaseCommand.connectionFlags,
@@ -24,7 +24,6 @@ export default class GetDocuments extends BaseCommand {
             helpValue: "<index>",
         }),
         ids: Flags.string({
-            aliases: ["id"],
             description: "Document identifiers to return, comma-separated.",
             helpValue: "<ids>",
         }),
@@ -47,10 +46,10 @@ export default class GetDocuments extends BaseCommand {
         ...BaseCommand.bodyInputFlags,
     };
     async run() {
-        const { flags } = await this.parse(GetDocuments);
+        const { flags } = await this.parse(DocumentList);
         const given = readJsonBody(flags);
         if (given !== undefined && !isJsonObject(given)) {
-            throw new MeiliCliError("cli_input_invalid", "The body of `get documents` is the query object of POST /indexes/{index_uid}/documents/fetch, not an array.", { hint: "Pass the identifiers as `--data '{\"ids\":[42,1344]}'` or as `--ids 42,1344`." });
+            throw new MeiliCliError("cli_input_invalid", "The body of `document list` is the query object of POST /indexes/{index_uid}/documents/fetch, not an array.", { hint: "Pass the identifiers as `--data '{\"ids\":[42,1344]}'` or as `--ids 42,1344`." });
         }
         const query = { ...given };
         if (flags.ids !== undefined)
@@ -71,4 +70,4 @@ export default class GetDocuments extends BaseCommand {
         await this.outputList((page) => fetchDocuments(this.meilisearch, flags.index, { ...rest, ...page }), { limit, offset }, flags.all, nextOffsetQuery);
     }
 }
-//# sourceMappingURL=documents.js.map
+//# sourceMappingURL=list.js.map

package/dist/commands/document/list.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"list.js","sourceRoot":"","sources":["../../../src/commands/document/list.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEpC,OAAO,EAAY,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAChE,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE1D,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,WAAW;IACnD,MAAM,CAAC,GAAG,GAAQ,aAAa,CAAC;IAEhC,MAAM,CAAC,MAAM,GAAG,CAAC,2CAA2C,CAAC,CAAC;IAE9D,MAAM,CAAC,UAAU,GAAG,CAAC,eAAe,CAAC,CAAC;IAEtC,MAAM,CAAU,WAAW,GAAG;;mCAEG,CAAC;IAElC,MAAM,CAAU,QAAQ,GAAG;QACzB,mEAAmE;QACnE,mGAAmG;QACnG,4GAA4G;KAC7G,CAAC;IAEF,MAAM,CAAU,KAAK,GAAG;QACtB,GAAG,WAAW,CAAC,eAAe;QAC9B,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC;YAClB,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,uCAAuC;YACpD,SAAS,EAAE,SAAS;SACrB,CAAC;QACF,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC;YAChB,WAAW,EAAE,kDAAkD;YAC/D,SAAS,EAAE,OAAO;SACnB,CAAC;QACF,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;YACnB,WAAW,EACT,4FAA4F;YAC9F,SAAS,EAAE,UAAU;SACtB,CAAC;QACF,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;YACnB,WAAW,EAAE,0EAA0E;YACvF,SAAS,EAAE,UAAU;SACtB,CAAC;QACF,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC;YACjB,WAAW,EAAE,6EAA6E;YAC1F,SAAS,EAAE,QAAQ;SACpB,CAAC;QACF,kBAAkB,EAAE,KAAK,CAAC,OAAO,CAAC;YAChC,WAAW,EAAE,gEAAgE;SAC9E,CAAC;QACF,GAAG,WAAW,CAAC,eAAe;QAC9B,GAAG,WAAW,CAAC,cAAc;KAC9B,CAAC;IAEF,KAAK,CAAC,GAAG;QACP,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QACjD,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;QAClC,IAAI,KAAK,KAAK,SAAS,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;YAChD,MAAM,IAAI,aAAa,CACrB,mBAAmB,EACnB,6GAA6G,EAC7G,EAAE,IAAI,EAAE,+EAA+E,EAAE,CAC1F,CAAC;QACJ,CAAC;QAED,MAAM,KAAK,GAAG,EAAE,GAAG,KAAK,EAAoB,CAAC;QAC7C,IAAI,KAAK,CAAC,GAAG,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC9D,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS;YAAE,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC5D,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS;YAAE,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACvE,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS;YAAE,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACjE,IAAI,KAAK,CAAC,kBAAkB,CAAC;YAAE,KAAK,CAAC,eAAe,GAAG,IAAI,CAAC;QAC5D,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS;YAAE,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;QACzD,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS;YAAE,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAE5D,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC;QACzC,MAAM,IAAI,CAAC,UAAU,CACnB,CAAC,IAAI,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,KAAK,EAAE,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,EAAE,CAAC,EAC7E,EAAE,KAAK,EAAE,MAAM,EAAE,EACjB,KAAK,CAAC,GAAG,EACT,eAAe,CAChB,CAAC;IACJ,CAAC;CACF"}

package/dist/commands/{update/documents.js → document/update.js}

@@ -2,14 +2,15 @@ import { Flags } from "@oclif/core";
 import { BaseCommand } from "../../lib/base-command.js";
 import { MeiliCliError } from "../../lib/errors.js";
 import { readJsonBody } from "../../lib/input.js";
-export default class UpdateDocuments extends BaseCommand {
+export default class DocumentUpdate extends BaseCommand {
     static api = "meilisearch";
     static routes = ["PUT /indexes/{index_uid}/documents"];
     static keyActions = ["documents.add"];
-    static description = "Add documents to an index, merging their fields into the ones that already have the same primary key.";
+    static description = `Add or update documents in an index.
+
+The fields of a document are merged into the one that has the same primary key.`;
     static examples = [
         "<%= config.bin %> <%= command.id %> --project prod --index movies --file changes.json",
-        "<%= config.bin %> <%= command.id %> --project prod --index movies --file changes.json --output json",
         "cat changes.json | <%= config.bin %> <%= command.id %> --project prod --index movies --file -",
         '<%= config.bin %> <%= command.id %> --project prod --index movies --data \'[{"id":1,"rating":4}]\'',
         "<%= config.bin %> <%= command.id %> --project prod --index movies --file changes.json --wait",
@@ -36,7 +37,7 @@ export default class UpdateDocuments extends BaseCommand {
         ...BaseCommand.waitFlags,
     };
     async run() {
-        const { flags } = await this.parse(UpdateDocuments);
+        const { flags } = await this.parse(DocumentUpdate);
         const documents = readJsonBody(flags);
         if (documents === undefined) {
             throw new MeiliCliError("cli_usage", "The documents to update are missing.", {
@@ -53,4 +54,4 @@ export default class UpdateDocuments extends BaseCommand {
         await this.outputTask(task, flags);
     }
 }
-//# sourceMappingURL=documents.js.map
+//# sourceMappingURL=update.js.map

package/dist/commands/document/update.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"update.js","sourceRoot":"","sources":["../../../src/commands/document/update.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEpC,OAAO,EAAY,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,WAAW;IACrD,MAAM,CAAC,GAAG,GAAQ,aAAa,CAAC;IAEhC,MAAM,CAAC,MAAM,GAAG,CAAC,oCAAoC,CAAC,CAAC;IAEvD,MAAM,CAAC,UAAU,GAAG,CAAC,eAAe,CAAC,CAAC;IAEtC,MAAM,CAAU,WAAW,GAAG;;gFAEgD,CAAC;IAE/E,MAAM,CAAU,QAAQ,GAAG;QACzB,uFAAuF;QACvF,+FAA+F;QAC/F,oGAAoG;QACpG,8FAA8F;KAC/F,CAAC;IAEF,MAAM,CAAU,KAAK,GAAG;QACtB,GAAG,WAAW,CAAC,eAAe;QAC9B,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC;YAClB,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,uCAAuC;YACpD,SAAS,EAAE,SAAS;SACrB,CAAC;QACF,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC;YAC1B,WAAW,EAAE,2EAA2E;YACxF,SAAS,EAAE,SAAS;SACrB,CAAC;QACF,iBAAiB,EAAE,KAAK,CAAC,MAAM,CAAC;YAC9B,WAAW,EAAE,2DAA2D;YACxE,SAAS,EAAE,UAAU;SACtB,CAAC;QACF,eAAe,EAAE,KAAK,CAAC,OAAO,CAAC;YAC7B,WAAW,EAAE,gEAAgE;SAC9E,CAAC;QACF,GAAG,WAAW,CAAC,cAAc;QAC7B,GAAG,WAAW,CAAC,SAAS;KACzB,CAAC;IAEF,KAAK,CAAC,GAAG;QACP,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QACnD,MAAM,SAAS,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;QACtC,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,MAAM,IAAI,aAAa,CAAC,WAAW,EAAE,sCAAsC,EAAE;gBAC3E,IAAI,EAAE,iFAAiF;aACxF,CAAC,CAAC;QACL,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW;aAChC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC;aAClB,eAAe,CAAC,SAAwB,EAAE;YACzC,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC;YAChC,cAAc,EAAE,KAAK,CAAC,iBAAiB,CAAC;YACxC,YAAY,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;SACxD,CAAC,CAAC;QACL,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACrC,CAAC;CACF"}

package/dist/commands/document/view.js

@@ -0,0 +1,42 @@
+import { Flags } from "@oclif/core";
+import { BaseCommand } from "../../lib/base-command.js";
+export default class DocumentView extends BaseCommand {
+    static api = "meilisearch";
+    static routes = ["GET /indexes/{index_uid}/documents/{document_id}"];
+    static keyActions = ["documents.get"];
+    static description = "Get one document of an index.";
+    static examples = [
+        "<%= config.bin %> <%= command.id %> --project prod --index movies --id 42",
+        "<%= config.bin %> <%= command.id %> --project prod --index movies --id 42 --fields id,title",
+    ];
+    static flags = {
+        ...BaseCommand.connectionFlags,
+        index: Flags.string({
+            required: true,
+            description: "The index to read the document from.",
+            helpValue: "<index>",
+        }),
+        id: Flags.string({
+            required: true,
+            description: "The document identifier.",
+            helpValue: "<id>",
+        }),
+        fields: Flags.string({
+            description: "Document attributes to return, comma-separated. Defaults to all of them.",
+            helpValue: "<fields>",
+        }),
+        "retrieve-vectors": Flags.boolean({
+            description: "Include the vector embeddings of the document, if it has them.",
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(DocumentView);
+        // meilisearch-js does not type `retrieveVectors`, and sends it as a query parameter all the same.
+        const query = {
+            fields: flags.fields?.split(","),
+            retrieveVectors: flags["retrieve-vectors"] ? true : undefined,
+        };
+        await this.output(await this.meilisearch.index(flags.index).getDocument(flags.id, query));
+    }
+}
+//# sourceMappingURL=view.js.map

package/dist/commands/document/view.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"view.js","sourceRoot":"","sources":["../../../src/commands/document/view.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEpC,OAAO,EAAY,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAElE,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,WAAW;IACnD,MAAM,CAAC,GAAG,GAAQ,aAAa,CAAC;IAEhC,MAAM,CAAC,MAAM,GAAG,CAAC,kDAAkD,CAAC,CAAC;IAErE,MAAM,CAAC,UAAU,GAAG,CAAC,eAAe,CAAC,CAAC;IAEtC,MAAM,CAAU,WAAW,GAAG,+BAA+B,CAAC;IAE9D,MAAM,CAAU,QAAQ,GAAG;QACzB,2EAA2E;QAC3E,6FAA6F;KAC9F,CAAC;IAEF,MAAM,CAAU,KAAK,GAAG;QACtB,GAAG,WAAW,CAAC,eAAe;QAC9B,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC;YAClB,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,sCAAsC;YACnD,SAAS,EAAE,SAAS;SACrB,CAAC;QACF,EAAE,EAAE,KAAK,CAAC,MAAM,CAAC;YACf,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,0BAA0B;YACvC,SAAS,EAAE,MAAM;SAClB,CAAC;QACF,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;YACnB,WAAW,EAAE,0EAA0E;YACvF,SAAS,EAAE,UAAU;SACtB,CAAC;QACF,kBAAkB,EAAE,KAAK,CAAC,OAAO,CAAC;YAChC,WAAW,EAAE,gEAAgE;SAC9E,CAAC;KACH,CAAC;IAEF,KAAK,CAAC,GAAG;QACP,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QACjD,kGAAkG;QAClG,MAAM,KAAK,GAAG;YACZ,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC;YAChC,eAAe,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;SAC7C,CAAC;QACnB,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;IAC5F,CAAC;CACF"}

package/dist/commands/export.js

@@ -10,12 +10,13 @@ export default class Export extends BaseCommand {
     static api = "meilisearch";
     static routes = ["POST /export"];
     static keyActions = ["export"];
-    static description = `Send the documents and the settings of the source instance to the destination instance, and answer the task that does it.
+    static description = `Export the data of the instance to another instance.
+
+Sends the documents and the settings to the destination instance, and prints the task that does it.
 
 The source is the project this command connects to, named by --project, --project-url and --project-api-key as on every command: it receives the request and does the export. The destination is --url with --api-key, or --project-destination, an entry of the config file. --indexes narrows the export to the indexes those patterns match.`;
     static examples = [
         "<%= config.bin %> <%= command.id %> --project prod --url https://ms-1234.heaven.meilisearch.com --api-key <key>",
-        "<%= config.bin %> <%= command.id %> --project prod --url https://ms-1234.heaven.meilisearch.com --api-key <key> --output json",
         "<%= config.bin %> <%= command.id %> --project staging --project-destination prod",
         `<%= config.bin %> <%= command.id %> --project prod --url http://localhost:7701 --indexes '{"movies":{"filter":"rating > 4"}}' --wait`,
         "<%= config.bin %> <%= command.id %> --project prod --url http://localhost:7701 --payload-size 24MiB",

package/dist/commands/export.js.map

@@ -1 +1 @@
-{"version":3,"file":"export.js","sourceRoot":"","sources":["../../src/commands/export.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAY,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAElD,mFAAmF;AACnF,MAAM,WAAW,GAAG,aAAa,CAAC;AAElC,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,WAAW;IAC7C,MAAM,CAAC,GAAG,GAAQ,aAAa,CAAC;IAEhC,MAAM,CAAC,MAAM,GAAG,CAAC,cAAc,CAAC,CAAC;IAEjC,MAAM,CAAC,UAAU,GAAG,CAAC,QAAQ,CAAC,CAAC;IAE/B,MAAM,CAAU,WAAW,GACzB;;gVAE4U,CAAC;IAE/U,MAAM,CAAU,QAAQ,GAAG;QACzB,iHAAiH;QACjH,+HAA+H;QAC/H,kFAAkF;QAClF,sIAAsI;QACtI,qGAAqG;QACrG,uIAAuI;KACxI,CAAC;IAEF,MAAM,CAAU,KAAK,GAAG;QACtB,GAAG,WAAW,CAAC,eAAe;QAC9B,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC;YAChB,WAAW,EAAE,+DAA+D;YAC5E,SAAS,EAAE,OAAO;YAClB,SAAS,EAAE,WAAW;SACvB,CAAC;QACF,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC;YACtB,WAAW,EACT,qHAAqH;YACvH,SAAS,EAAE,OAAO;YAClB,SAAS,EAAE,WAAW;SACvB,CAAC;QACF,qBAAqB,EAAE,KAAK,CAAC,MAAM,CAAC;YAClC,WAAW,EACT,8JAA8J;YAChK,SAAS,EAAE,QAAQ;YACnB,SAAS,EAAE,WAAW;YACtB,SAAS,EAAE,CAAC,KAAK,CAAC;SACnB,CAAC;QACF,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC;YAC3B,WAAW,EAAE,yEAAyE;YACtF,SAAS,EAAE,QAAQ;YACnB,SAAS,EAAE,WAAW;SACvB,CAAC;QACF,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC;YACpB,WAAW,EACT,iJAAiJ;YACnJ,SAAS,EAAE,QAAQ;SACpB,CAAC;QACF,GAAG,WAAW,CAAC,cAAc;QAC7B,GAAG,WAAW,CAAC,SAAS;KACzB,CAAC;IAEF,KAAK,CAAC,GAAG;QACP,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC3C,MAAM,IAAI,GAAG,KAAK,CAAC,qBAAqB,CAAC,CAAC;QAC1C,MAAM,WAAW,GAAG,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,CAAC,CAAC;QACxF,MAAM,IAAI,GAAG,kBAAkB,CAAC,KAAK,EAAE;YACrC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,WAAW,EAAE,GAAG,CAAC;YAC1C,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,WAAW,EAAE,MAAM,CAAC;YACvD,WAAW,EAAE,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;YAC1C,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC;SAC/B,CAAC,CAAC;QACH,MAAM,IAAI,CAAC,UAAU,CAAC,MAAM,aAAa,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC;IAC5E,CAAC;CACF"}
+{"version":3,"file":"export.js","sourceRoot":"","sources":["../../src/commands/export.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAY,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAElD,mFAAmF;AACnF,MAAM,WAAW,GAAG,aAAa,CAAC;AAElC,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,WAAW;IAC7C,MAAM,CAAC,GAAG,GAAQ,aAAa,CAAC;IAEhC,MAAM,CAAC,MAAM,GAAG,CAAC,cAAc,CAAC,CAAC;IAEjC,MAAM,CAAC,UAAU,GAAG,CAAC,QAAQ,CAAC,CAAC;IAE/B,MAAM,CAAU,WAAW,GAAG;;;;gVAIgT,CAAC;IAE/U,MAAM,CAAU,QAAQ,GAAG;QACzB,iHAAiH;QACjH,kFAAkF;QAClF,sIAAsI;QACtI,qGAAqG;QACrG,uIAAuI;KACxI,CAAC;IAEF,MAAM,CAAU,KAAK,GAAG;QACtB,GAAG,WAAW,CAAC,eAAe;QAC9B,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC;YAChB,WAAW,EAAE,+DAA+D;YAC5E,SAAS,EAAE,OAAO;YAClB,SAAS,EAAE,WAAW;SACvB,CAAC;QACF,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC;YACtB,WAAW,EACT,qHAAqH;YACvH,SAAS,EAAE,OAAO;YAClB,SAAS,EAAE,WAAW;SACvB,CAAC;QACF,qBAAqB,EAAE,KAAK,CAAC,MAAM,CAAC;YAClC,WAAW,EACT,8JAA8J;YAChK,SAAS,EAAE,QAAQ;YACnB,SAAS,EAAE,WAAW;YACtB,SAAS,EAAE,CAAC,KAAK,CAAC;SACnB,CAAC;QACF,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC;YAC3B,WAAW,EAAE,yEAAyE;YACtF,SAAS,EAAE,QAAQ;YACnB,SAAS,EAAE,WAAW;SACvB,CAAC;QACF,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC;YACpB,WAAW,EACT,iJAAiJ;YACnJ,SAAS,EAAE,QAAQ;SACpB,CAAC;QACF,GAAG,WAAW,CAAC,cAAc;QAC7B,GAAG,WAAW,CAAC,SAAS;KACzB,CAAC;IAEF,KAAK,CAAC,GAAG;QACP,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC3C,MAAM,IAAI,GAAG,KAAK,CAAC,qBAAqB,CAAC,CAAC;QAC1C,MAAM,WAAW,GAAG,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,CAAC,CAAC;QACxF,MAAM,IAAI,GAAG,kBAAkB,CAAC,KAAK,EAAE;YACrC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,WAAW,EAAE,GAAG,CAAC;YAC1C,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,WAAW,EAAE,MAAM,CAAC;YACvD,WAAW,EAAE,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;YAC1C,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC;SAC/B,CAAC,CAAC;QACH,MAAM,IAAI,CAAC,UAAU,CAAC,MAAM,aAAa,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC;IAC5E,CAAC;CACF"}

package/dist/commands/facet-search.js

@@ -6,10 +6,11 @@ export default class FacetSearch extends BaseCommand {
     static api = "meilisearch";
     static routes = ["POST /indexes/{index_uid}/facet-search"];
     static keyActions = ["search"];
-    static description = "Search the values of one facet attribute of an index, counted on the documents --q and --filter keep.";
+    static description = `Search the values of a facet.
+
+Counts the values on the documents that --q and --filter keep.`;
     static examples = [
         "<%= config.bin %> <%= command.id %> --project prod --index movies --facet-name genres --facet-query ac",
-        "<%= config.bin %> <%= command.id %> --project prod --index movies --facet-name genres --facet-query ac --output json",
         "<%= config.bin %> <%= command.id %> --project prod --index movies --facet-name genres --q horror --filter 'rating > 4'",
         '<%= config.bin %> <%= command.id %> --project prod --index movies --data \'{"facetName":"genres","facetQuery":"ac"}\'',
     ];

package/dist/commands/facet-search.js.map

@@ -1 +1 @@
-{"version":3,"file":"facet-search.js","sourceRoot":"","sources":["../../src/commands/facet-search.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEpC,OAAO,EAAY,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAC/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAEpD,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,WAAW;IAClD,MAAM,CAAC,GAAG,GAAQ,aAAa,CAAC;IAEhC,MAAM,CAAC,MAAM,GAAG,CAAC,wCAAwC,CAAC,CAAC;IAE3D,MAAM,CAAC,UAAU,GAAG,CAAC,QAAQ,CAAC,CAAC;IAE/B,MAAM,CAAU,WAAW,GACzB,uGAAuG,CAAC;IAE1G,MAAM,CAAU,QAAQ,GAAG;QACzB,wGAAwG;QACxG,sHAAsH;QACtH,wHAAwH;QACxH,uHAAuH;KACxH,CAAC;IAEF,MAAM,CAAU,KAAK,GAAG;QACtB,GAAG,WAAW,CAAC,eAAe;QAC9B,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC;YAClB,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,0CAA0C;YACvD,SAAS,EAAE,SAAS;SACrB,CAAC;QACF,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC;YACzB,WAAW,EACT,6FAA6F;YAC/F,SAAS,EAAE,aAAa;SACzB,CAAC;QACF,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC;YAC1B,WAAW,EACT,gHAAgH;YAClH,SAAS,EAAE,SAAS;SACrB,CAAC;QACF,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC;YACd,WAAW,EACT,yGAAyG;YAC3G,SAAS,EAAE,SAAS;SACrB,CAAC;QACF,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;YACnB,WAAW,EACT,4FAA4F;YAC9F,SAAS,EAAE,UAAU;SACtB,CAAC;QACF,mBAAmB,EAAE,KAAK,CAAC,MAAM,CAAC;YAChC,OAAO,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,WAAW,CAAU;YAC9C,WAAW,EAAE,qEAAqE;SACnF,CAAC,EAAE;QACJ,yBAAyB,EAAE,KAAK,CAAC,MAAM,CAAC;YACtC,WAAW,EAAE,6EAA6E;YAC1F,SAAS,EAAE,UAAU;SACtB,CAAC;QACF,yBAAyB,EAAE,KAAK,CAAC,MAAM,CAAC;YACtC,WAAW,EACT,uFAAuF;YACzF,SAAS,EAAE,UAAU;SACtB,CAAC;QACF,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC;YACpB,WAAW,EAAE,2EAA2E;YACxF,SAAS,EAAE,WAAW;SACvB,CAAC;QACF,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;YACnB,WAAW,EACT,kFAAkF;YACpF,SAAS,EAAE,QAAQ;SACpB,CAAC;QACF,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;YACnB,WAAW,EAAE,qEAAqE;YAClF,SAAS,EAAE,WAAW;SACvB,CAAC;QACF,wBAAwB,EAAE,KAAK,CAAC,OAAO,CAAC;YACtC,WAAW,EAAE,uEAAuE;SACrF,CAAC;QACF,GAAG,WAAW,CAAC,cAAc;KAC9B,CAAC;IAEF,KAAK,CAAC,GAAG;QACP,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAChD,MAAM,SAAS,GAAwC;YACrD,SAAS,EAAE,KAAK,CAAC,YAAY,CAAC;YAC9B,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC;YAChC,CAAC,EAAE,KAAK,CAAC,CAAC;YACV,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,gBAAgB,EAAE,KAAK,CAAC,mBAAmB,CAAC;YAC5C,oBAAoB,EAAE,KAAK,CAAC,yBAAyB,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC;YAClE,qBAAqB,EAAE,QAAQ,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAuB;YACvF,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,GAAG,CAAC;YAClC,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAA6B;YACxD,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAyB;YACtE,oBAAoB,EAAE,KAAK,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;SACzE,CAAC;QAEF,MAAM,MAAM,GAAG,kBAAkB,CAAC,KAAK,EAAE,SAAS,CAA+B,CAAC;QAElF,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC;IAC5F,CAAC;CACF"}
+{"version":3,"file":"facet-search.js","sourceRoot":"","sources":["../../src/commands/facet-search.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEpC,OAAO,EAAY,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAC/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAEpD,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,WAAW;IAClD,MAAM,CAAC,GAAG,GAAQ,aAAa,CAAC;IAEhC,MAAM,CAAC,MAAM,GAAG,CAAC,wCAAwC,CAAC,CAAC;IAE3D,MAAM,CAAC,UAAU,GAAG,CAAC,QAAQ,CAAC,CAAC;IAE/B,MAAM,CAAU,WAAW,GAAG;;+DAE+B,CAAC;IAE9D,MAAM,CAAU,QAAQ,GAAG;QACzB,wGAAwG;QACxG,wHAAwH;QACxH,uHAAuH;KACxH,CAAC;IAEF,MAAM,CAAU,KAAK,GAAG;QACtB,GAAG,WAAW,CAAC,eAAe;QAC9B,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC;YAClB,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,0CAA0C;YACvD,SAAS,EAAE,SAAS;SACrB,CAAC;QACF,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC;YACzB,WAAW,EACT,6FAA6F;YAC/F,SAAS,EAAE,aAAa;SACzB,CAAC;QACF,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC;YAC1B,WAAW,EACT,gHAAgH;YAClH,SAAS,EAAE,SAAS;SACrB,CAAC;QACF,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC;YACd,WAAW,EACT,yGAAyG;YAC3G,SAAS,EAAE,SAAS;SACrB,CAAC;QACF,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;YACnB,WAAW,EACT,4FAA4F;YAC9F,SAAS,EAAE,UAAU;SACtB,CAAC;QACF,mBAAmB,EAAE,KAAK,CAAC,MAAM,CAAC;YAChC,OAAO,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,WAAW,CAAU;YAC9C,WAAW,EAAE,qEAAqE;SACnF,CAAC,EAAE;QACJ,yBAAyB,EAAE,KAAK,CAAC,MAAM,CAAC;YACtC,WAAW,EAAE,6EAA6E;YAC1F,SAAS,EAAE,UAAU;SACtB,CAAC;QACF,yBAAyB,EAAE,KAAK,CAAC,MAAM,CAAC;YACtC,WAAW,EACT,uFAAuF;YACzF,SAAS,EAAE,UAAU;SACtB,CAAC;QACF,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC;YACpB,WAAW,EAAE,2EAA2E;YACxF,SAAS,EAAE,WAAW;SACvB,CAAC;QACF,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;YACnB,WAAW,EACT,kFAAkF;YACpF,SAAS,EAAE,QAAQ;SACpB,CAAC;QACF,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;YACnB,WAAW,EAAE,qEAAqE;YAClF,SAAS,EAAE,WAAW;SACvB,CAAC;QACF,wBAAwB,EAAE,KAAK,CAAC,OAAO,CAAC;YACtC,WAAW,EAAE,uEAAuE;SACrF,CAAC;QACF,GAAG,WAAW,CAAC,cAAc;KAC9B,CAAC;IAEF,KAAK,CAAC,GAAG;QACP,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAChD,MAAM,SAAS,GAAwC;YACrD,SAAS,EAAE,KAAK,CAAC,YAAY,CAAC;YAC9B,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC;YAChC,CAAC,EAAE,KAAK,CAAC,CAAC;YACV,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,gBAAgB,EAAE,KAAK,CAAC,mBAAmB,CAAC;YAC5C,oBAAoB,EAAE,KAAK,CAAC,yBAAyB,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC;YAClE,qBAAqB,EAAE,QAAQ,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAuB;YACvF,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,GAAG,CAAC;YAClC,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAA6B;YACxD,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAyB;YACtE,oBAAoB,EAAE,KAAK,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;SACzE,CAAC;QAEF,MAAM,MAAM,GAAG,kBAAkB,CAAC,KAAK,EAAE,SAAS,CAA+B,CAAC;QAElF,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC;IAC5F,CAAC;CACF"}

package/dist/commands/{get/health.js → health.js}

@@ -1,11 +1,10 @@
-import { BaseCommand } from "../../lib/base-command.js";
-export default class GetHealth extends BaseCommand {
+import { BaseCommand } from "../lib/base-command.js";
+export default class Health extends BaseCommand {
     static api = "meilisearch";
     static routes = ["GET /health"];
-    static description = "Check that the Meilisearch instance is available.";
+    static description = "Check that the instance is available.";
     static examples = [
         "<%= config.bin %> <%= command.id %> --project prod",
-        "<%= config.bin %> <%= command.id %> --project prod --output json",
         "<%= config.bin %> <%= command.id %> --project-url http://localhost:7700",
     ];
     static flags = { ...BaseCommand.connectionFlags };

package/dist/commands/health.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"health.js","sourceRoot":"","sources":["../../src/commands/health.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAE/D,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,WAAW;IAC7C,MAAM,CAAC,GAAG,GAAQ,aAAa,CAAC;IAEhC,MAAM,CAAC,MAAM,GAAG,CAAC,aAAa,CAAC,CAAC;IAEhC,MAAM,CAAU,WAAW,GAAG,uCAAuC,CAAC;IAEtE,MAAM,CAAU,QAAQ,GAAG;QACzB,oDAAoD;QACpD,yEAAyE;KAC1E,CAAC;IAEF,MAAM,CAAU,KAAK,GAAG,EAAE,GAAG,WAAW,CAAC,eAAe,EAAE,CAAC;IAE3D,KAAK,CAAC,GAAG;QACP,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;QAC/C,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC5B,CAAC;CACF"}

package/dist/commands/{add/indexes.js → index/add.js}

@@ -1,14 +1,16 @@
 import { Flags } from "@oclif/core";
 import { BaseCommand } from "../../lib/base-command.js";
 import { readJsonObjectBody } from "../../lib/input.js";
-export default class AddIndexes extends BaseCommand {
+export default class IndexAdd extends BaseCommand {
     static api = "meilisearch";
     static routes = ["POST /indexes"];
     static keyActions = ["indexes.create"];
-    static description = "Create an empty index, named by --id, with --primary-key as its primary key.";
+    static description = `Create an index.
+
+--id names it, and --primary-key sets its primary key.`;
     static examples = [
         "<%= config.bin %> <%= command.id %> --project prod --id movies",
-        "<%= config.bin %> <%= command.id %> --project prod --id movies --primary-key id --output json",
+        "<%= config.bin %> <%= command.id %> --project prod --id movies --primary-key id",
         "<%= config.bin %> <%= command.id %> --project prod --id movies --wait",
     ];
     static flags = {
@@ -27,7 +29,7 @@ export default class AddIndexes extends BaseCommand {
         ...BaseCommand.waitFlags,
     };
     async run() {
-        const { flags } = await this.parse(AddIndexes);
+        const { flags } = await this.parse(IndexAdd);
         // The body goes out whole, so a field this command declares no flag for
         // reaches the API, which refuses it rather than the CLI dropping it.
         const options = { ...readJsonObjectBody(flags) };
@@ -36,4 +38,4 @@ export default class AddIndexes extends BaseCommand {
         await this.outputTask(await this.meilisearch.createIndex(flags.id, options), flags);
     }
 }
-//# sourceMappingURL=indexes.js.map
+//# sourceMappingURL=add.js.map

package/dist/commands/index/add.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"add.js","sourceRoot":"","sources":["../../../src/commands/index/add.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEpC,OAAO,EAAY,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAExD,MAAM,CAAC,OAAO,OAAO,QAAS,SAAQ,WAAW;IAC/C,MAAM,CAAC,GAAG,GAAQ,aAAa,CAAC;IAEhC,MAAM,CAAC,MAAM,GAAG,CAAC,eAAe,CAAC,CAAC;IAElC,MAAM,CAAC,UAAU,GAAG,CAAC,gBAAgB,CAAC,CAAC;IAEvC,MAAM,CAAU,WAAW,GAAG;;uDAEuB,CAAC;IAEtD,MAAM,CAAU,QAAQ,GAAG;QACzB,gEAAgE;QAChE,iFAAiF;QACjF,uEAAuE;KACxE,CAAC;IAEF,MAAM,CAAU,KAAK,GAAG;QACtB,GAAG,WAAW,CAAC,eAAe;QAC9B,EAAE,EAAE,KAAK,CAAC,MAAM,CAAC;YACf,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,CAAC,KAAK,CAAC;YAChB,WAAW,EAAE,sBAAsB;YACnC,SAAS,EAAE,SAAS;SACrB,CAAC;QACF,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC;YAC1B,WAAW,EACT,mHAAmH;YACrH,SAAS,EAAE,SAAS;SACrB,CAAC;QACF,GAAG,WAAW,CAAC,cAAc;QAC7B,GAAG,WAAW,CAAC,SAAS;KACzB,CAAC;IAEF,KAAK,CAAC,GAAG;QACP,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC7C,wEAAwE;QACxE,qEAAqE;QACrE,MAAM,OAAO,GAAG,EAAE,GAAG,kBAAkB,CAAC,KAAK,CAAC,EAAkB,CAAC;QACjE,IAAI,KAAK,CAAC,aAAa,CAAC,KAAK,SAAS;YAAE,OAAO,CAAC,UAAU,GAAG,KAAK,CAAC,aAAa,CAAC,CAAC;QAClF,MAAM,IAAI,CAAC,UAAU,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,EAAE,OAAO,CAAC,EAAE,KAAK,CAAC,CAAC;IACtF,CAAC;CACF"}

package/dist/commands/{delete/indexes.js → index/delete.js}

@@ -1,13 +1,14 @@
 import { Flags } from "@oclif/core";
 import { BaseCommand } from "../../lib/base-command.js";
-export default class DeleteIndexes extends BaseCommand {
+export default class IndexDelete extends BaseCommand {
     static api = "meilisearch";
     static routes = ["DELETE /indexes/{index_uid}"];
     static keyActions = ["indexes.delete"];
-    static description = "Delete an index, with its documents, its settings and its task history.";
+    static description = `Delete an index.
+
+Deletes its documents, its settings and its task history too.`;
     static examples = [
         "<%= config.bin %> <%= command.id %> --project prod --id movies --yes",
-        "<%= config.bin %> <%= command.id %> --project prod --id movies --yes --output json",
         "<%= config.bin %> <%= command.id %> --project prod --id movies --yes --wait",
     ];
     static flags = {
@@ -21,8 +22,8 @@ export default class DeleteIndexes extends BaseCommand {
         ...BaseCommand.confirmFlags,
     };
     async run() {
-        const { flags } = await this.parse(DeleteIndexes);
+        const { flags } = await this.parse(IndexDelete);
         await this.outputTask(await this.meilisearch.deleteIndex(flags.id), flags);
     }
 }
-//# sourceMappingURL=indexes.js.map
+//# sourceMappingURL=delete.js.map

package/dist/commands/index/delete.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"delete.js","sourceRoot":"","sources":["../../../src/commands/index/delete.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAY,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAElE,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,WAAW;IAClD,MAAM,CAAC,GAAG,GAAQ,aAAa,CAAC;IAEhC,MAAM,CAAC,MAAM,GAAG,CAAC,6BAA6B,CAAC,CAAC;IAEhD,MAAM,CAAC,UAAU,GAAG,CAAC,gBAAgB,CAAC,CAAC;IAEvC,MAAM,CAAU,WAAW,GAAG;;8DAE8B,CAAC;IAE7D,MAAM,CAAU,QAAQ,GAAG;QACzB,sEAAsE;QACtE,6EAA6E;KAC9E,CAAC;IAEF,MAAM,CAAU,KAAK,GAAG;QACtB,GAAG,WAAW,CAAC,eAAe;QAC9B,EAAE,EAAE,KAAK,CAAC,MAAM,CAAC;YACf,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,sBAAsB;YACnC,SAAS,EAAE,SAAS;SACrB,CAAC;QACF,GAAG,WAAW,CAAC,SAAS;QACxB,GAAG,WAAW,CAAC,YAAY;KAC5B,CAAC;IAEF,KAAK,CAAC,GAAG;QACP,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAChD,MAAM,IAAI,CAAC,UAAU,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;IAC7E,CAAC;CACF"}

package/dist/commands/index/list.js

@@ -0,0 +1,21 @@
+import { BaseCommand } from "../../lib/base-command.js";
+import { nextOffsetQuery } from "../../lib/pagination.js";
+export default class IndexList extends BaseCommand {
+    static api = "meilisearch";
+    static routes = ["GET /indexes"];
+    static keyActions = ["indexes.get"];
+    static description = "List the indexes of the instance.";
+    static examples = [
+        "<%= config.bin %> <%= command.id %> --project prod",
+        "<%= config.bin %> <%= command.id %> --project prod --limit 5 --offset 10",
+    ];
+    static flags = {
+        ...BaseCommand.connectionFlags,
+        ...BaseCommand.paginationFlags,
+    };
+    async run() {
+        const { flags } = await this.parse(IndexList);
+        await this.outputList((query) => this.meilisearch.getRawIndexes(query), { limit: flags.limit, offset: flags.offset }, flags.all, nextOffsetQuery);
+    }
+}
+//# sourceMappingURL=list.js.map

package/dist/commands/index/list.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"list.js","sourceRoot":"","sources":["../../../src/commands/index/list.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE1D,MAAM,CAAC,OAAO,OAAO,SAAU,SAAQ,WAAW;IAChD,MAAM,CAAC,GAAG,GAAQ,aAAa,CAAC;IAEhC,MAAM,CAAC,MAAM,GAAG,CAAC,cAAc,CAAC,CAAC;IAEjC,MAAM,CAAC,UAAU,GAAG,CAAC,aAAa,CAAC,CAAC;IAEpC,MAAM,CAAU,WAAW,GAAG,mCAAmC,CAAC;IAElE,MAAM,CAAU,QAAQ,GAAG;QACzB,oDAAoD;QACpD,0EAA0E;KAC3E,CAAC;IAEF,MAAM,CAAU,KAAK,GAAG;QACtB,GAAG,WAAW,CAAC,eAAe;QAC9B,GAAG,WAAW,CAAC,eAAe;KAC/B,CAAC;IAEF,KAAK,CAAC,GAAG;QACP,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC9C,MAAM,IAAI,CAAC,UAAU,CACnB,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC,EAChD,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,EAC5C,KAAK,CAAC,GAAG,EACT,eAAe,CAChB,CAAC;IACJ,CAAC;CACF"}

package/dist/commands/{update/indexes.js → index/update.js}

@@ -1,14 +1,15 @@
 import { Flags } from "@oclif/core";
 import { BaseCommand } from "../../lib/base-command.js";
 import { readJsonObjectBody } from "../../lib/input.js";
-export default class UpdateIndexes extends BaseCommand {
+export default class IndexUpdate extends BaseCommand {
     static api = "meilisearch";
     static routes = ["PATCH /indexes/{index_uid}"];
     static keyActions = ["indexes.update"];
-    static description = "Change the primary key of an index with --primary-key, or rename it with --new-id.";
+    static description = `Change the primary key or the name of an index.
+
+--primary-key changes the primary key, and --new-id renames the index.`;
     static examples = [
         "<%= config.bin %> <%= command.id %> --project prod --id movies --primary-key movie_id",
-        "<%= config.bin %> <%= command.id %> --project prod --id movies --primary-key movie_id --output json",
         "<%= config.bin %> <%= command.id %> --project prod --id movies --new-id films",
         "<%= config.bin %> <%= command.id %> --project prod --id movies --new-id films --wait",
     ];
@@ -32,7 +33,7 @@ export default class UpdateIndexes extends BaseCommand {
         ...BaseCommand.waitFlags,
     };
     async run() {
-        const { flags } = await this.parse(UpdateIndexes);
+        const { flags } = await this.parse(IndexUpdate);
         const options = { ...readJsonObjectBody(flags) };
         if (flags["primary-key"] !== undefined)
             options.primaryKey = flags["primary-key"];
@@ -41,4 +42,4 @@ export default class UpdateIndexes extends BaseCommand {
         await this.outputTask(await this.meilisearch.updateIndex(flags.id, options), flags);
     }
 }
-//# sourceMappingURL=indexes.js.map
+//# sourceMappingURL=update.js.map

package/dist/commands/index/update.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"update.js","sourceRoot":"","sources":["../../../src/commands/index/update.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEpC,OAAO,EAAY,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAExD,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,WAAW;IAClD,MAAM,CAAC,GAAG,GAAQ,aAAa,CAAC;IAEhC,MAAM,CAAC,MAAM,GAAG,CAAC,4BAA4B,CAAC,CAAC;IAE/C,MAAM,CAAC,UAAU,GAAG,CAAC,gBAAgB,CAAC,CAAC;IAEvC,MAAM,CAAU,WAAW,GAAG;;uEAEuC,CAAC;IAEtE,MAAM,CAAU,QAAQ,GAAG;QACzB,uFAAuF;QACvF,+EAA+E;QAC/E,sFAAsF;KACvF,CAAC;IAEF,MAAM,CAAU,KAAK,GAAG;QACtB,GAAG,WAAW,CAAC,eAAe;QAC9B,EAAE,EAAE,KAAK,CAAC,MAAM,CAAC;YACf,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,sBAAsB;YACnC,SAAS,EAAE,SAAS;SACrB,CAAC;QACF,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC;YACrB,OAAO,EAAE,CAAC,KAAK,CAAC;YAChB,WAAW,EAAE,yCAAyC;YACtD,SAAS,EAAE,SAAS;SACrB,CAAC;QACF,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC;YAC1B,WAAW,EAAE,uDAAuD;YACpE,SAAS,EAAE,SAAS;SACrB,CAAC;QACF,GAAG,WAAW,CAAC,cAAc;QAC7B,GAAG,WAAW,CAAC,SAAS;KACzB,CAAC;IAEF,KAAK,CAAC,GAAG;QACP,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAChD,MAAM,OAAO,GAAG,EAAE,GAAG,kBAAkB,CAAC,KAAK,CAAC,EAAkB,CAAC;QACjE,IAAI,KAAK,CAAC,aAAa,CAAC,KAAK,SAAS;YAAE,OAAO,CAAC,UAAU,GAAG,KAAK,CAAC,aAAa,CAAC,CAAC;QAClF,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,SAAS;YAAE,OAAO,CAAC,GAAG,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;QACjE,MAAM,IAAI,CAAC,UAAU,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,EAAE,OAAO,CAAC,EAAE,KAAK,CAAC,CAAC;IACtF,CAAC;CACF"}

package/dist/commands/index/view.js

@@ -0,0 +1,18 @@
+import { Flags } from "@oclif/core";
+import { BaseCommand } from "../../lib/base-command.js";
+export default class IndexView extends BaseCommand {
+    static api = "meilisearch";
+    static routes = ["GET /indexes/{index_uid}"];
+    static keyActions = ["indexes.get"];
+    static description = "Get one index.";
+    static examples = ["<%= config.bin %> <%= command.id %> --project prod --id movies"];
+    static flags = {
+        ...BaseCommand.connectionFlags,
+        id: Flags.string({ required: true, description: "The index to get.", helpValue: "<index>" }),
+    };
+    async run() {
+        const { flags } = await this.parse(IndexView);
+        await this.output(await this.meilisearch.getRawIndex(flags.id));
+    }
+}
+//# sourceMappingURL=view.js.map

package/dist/commands/index/view.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"view.js","sourceRoot":"","sources":["../../../src/commands/index/view.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAY,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAElE,MAAM,CAAC,OAAO,OAAO,SAAU,SAAQ,WAAW;IAChD,MAAM,CAAC,GAAG,GAAQ,aAAa,CAAC;IAEhC,MAAM,CAAC,MAAM,GAAG,CAAC,0BAA0B,CAAC,CAAC;IAE7C,MAAM,CAAC,UAAU,GAAG,CAAC,aAAa,CAAC,CAAC;IAEpC,MAAM,CAAU,WAAW,GAAG,gBAAgB,CAAC;IAE/C,MAAM,CAAU,QAAQ,GAAG,CAAC,gEAAgE,CAAC,CAAC;IAE9F,MAAM,CAAU,KAAK,GAAG;QACtB,GAAG,WAAW,CAAC,eAAe;QAC9B,EAAE,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,WAAW,EAAE,mBAAmB,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC;KAC7F,CAAC;IAEF,KAAK,CAAC,GAAG;QACP,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC9C,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;IAClE,CAAC;CACF"}

package/dist/commands/info.js

@@ -0,0 +1,15 @@
+import { BaseCommand } from "../lib/base-command.js";
+export default class Info extends BaseCommand {
+    static api = "meilisearch";
+    static routes = ["GET /version"];
+    static keyActions = ["version"];
+    static description = `Get the version of the instance.
+
+Prints the version of Meilisearch and the commit it was built from.`;
+    static examples = ["<%= config.bin %> <%= command.id %> --project prod"];
+    static flags = { ...BaseCommand.connectionFlags };
+    async run() {
+        await this.output(await this.meilisearch.getVersion());
+    }
+}
+//# sourceMappingURL=info.js.map

package/dist/commands/info.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"info.js","sourceRoot":"","sources":["../../src/commands/info.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAE/D,MAAM,CAAC,OAAO,OAAO,IAAK,SAAQ,WAAW;IAC3C,MAAM,CAAC,GAAG,GAAQ,aAAa,CAAC;IAEhC,MAAM,CAAC,MAAM,GAAG,CAAC,cAAc,CAAC,CAAC;IAEjC,MAAM,CAAC,UAAU,GAAG,CAAC,SAAS,CAAC,CAAC;IAEhC,MAAM,CAAU,WAAW,GAAG;;oEAEoC,CAAC;IAEnE,MAAM,CAAU,QAAQ,GAAG,CAAC,oDAAoD,CAAC,CAAC;IAElF,MAAM,CAAU,KAAK,GAAG,EAAE,GAAG,WAAW,CAAC,eAAe,EAAE,CAAC;IAE3D,KAAK,CAAC,GAAG;QACP,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC,CAAC;IACzD,CAAC;CACF"}

package/dist/commands/{add/keys.js → key/add.js}

@@ -2,16 +2,18 @@ import { Flags } from "@oclif/core";
 import { BaseCommand } from "../../lib/base-command.js";
 import { readBodyWithFields } from "../../lib/input.js";
 import { asList, asText } from "../../lib/values.js";
-export default class AddKeys extends BaseCommand {
+export default class KeyAdd extends BaseCommand {
     static api = "meilisearch";
     static routes = ["POST /keys"];
     static keyActions = ["keys.create"];
-    static description = `Create an API key that runs --actions on --indexes until --expires-at.
+    static description = `Create an API key.
+
+The key runs --actions on --indexes until --expires-at.
 
 The answer carries the \`key\` field, the credential itself, on stdout like any other data.`;
     static examples = [
         "<%= config.bin %> <%= command.id %> --project prod --actions search --indexes movies --expires-at null",
-        "<%= config.bin %> <%= command.id %> --project prod --actions search --indexes '*' --expires-at 2027-01-01T00:00:00Z --output json",
+        "<%= config.bin %> <%= command.id %> --project prod --actions search --indexes '*' --expires-at 2027-01-01T00:00:00Z",
         "<%= config.bin %> <%= command.id %> --project prod --actions documents.add,documents.delete --indexes movies --expires-at null --name 'CI indexer'",
         '<%= config.bin %> <%= command.id %> --project prod --data \'{"actions":["search"],"indexes":["movies"],"expiresAt":null}\'',
     ];
@@ -35,17 +37,17 @@ The answer carries the \`key\` field, the credential itself, on stdout like any
             helpValue: "<date>",
         }),
         name: Flags.string({
-            description: "Name of the key, for a human reading the list.",
+            description: "Name of the key.",
             helpValue: "<name>",
         }),
         description: Flags.string({
-            description: "Description of the key, for a human reading the list.",
+            description: "Description of the key.",
             helpValue: "<text>",
         }),
         ...BaseCommand.bodyInputFlags,
     };
     async run() {
-        const { flags } = await this.parse(AddKeys);
+        const { flags } = await this.parse(KeyAdd);
         const fromFlags = {
             uid: flags.id,
             actions: asList(flags.actions),
@@ -60,4 +62,4 @@ The answer carries the \`key\` field, the credential itself, on stdout like any
         await this.output(await this.meilisearch.createKey(key));
     }
 }
-//# sourceMappingURL=keys.js.map
+//# sourceMappingURL=add.js.map

package/dist/commands/key/add.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"add.js","sourceRoot":"","sources":["../../../src/commands/key/add.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEpC,OAAO,EAAY,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAErD,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,WAAW;IAC7C,MAAM,CAAC,GAAG,GAAQ,aAAa,CAAC;IAEhC,MAAM,CAAC,MAAM,GAAG,CAAC,YAAY,CAAC,CAAC;IAE/B,MAAM,CAAC,UAAU,GAAG,CAAC,aAAa,CAAC,CAAC;IAEpC,MAAM,CAAU,WAAW,GAAG;;;;4FAI4D,CAAC;IAE3F,MAAM,CAAU,QAAQ,GAAG;QACzB,wGAAwG;QACxG,qHAAqH;QACrH,oJAAoJ;QACpJ,4HAA4H;KAC7H,CAAC;IAEF,MAAM,CAAU,KAAK,GAAG;QACtB,GAAG,WAAW,CAAC,eAAe;QAC9B,EAAE,EAAE,KAAK,CAAC,MAAM,CAAC;YACf,OAAO,EAAE,CAAC,KAAK,CAAC;YAChB,WAAW,EAAE,mEAAmE;YAChF,SAAS,EAAE,QAAQ;SACpB,CAAC;QACF,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC;YACpB,WAAW,EACT,wGAAwG;YAC1G,SAAS,EAAE,WAAW;SACvB,CAAC;QACF,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC;YACpB,WAAW,EACT,8GAA8G;YAChH,SAAS,EAAE,WAAW;SACvB,CAAC;QACF,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC;YACzB,WAAW,EACT,sFAAsF;YACxF,SAAS,EAAE,QAAQ;SACpB,CAAC;QACF,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC;YACjB,WAAW,EAAE,kBAAkB;YAC/B,SAAS,EAAE,QAAQ;SACpB,CAAC;QACF,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC;YACxB,WAAW,EAAE,yBAAyB;YACtC,SAAS,EAAE,QAAQ;SACpB,CAAC;QACF,GAAG,WAAW,CAAC,cAAc;KAC9B,CAAC;IAEF,KAAK,CAAC,GAAG;QACP,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC3C,MAAM,SAAS,GAA4B;YACzC,GAAG,EAAE,KAAK,CAAC,EAAE;YACb,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC;YAC9B,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC;YAC9B,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YACtC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;YACxB,WAAW,EAAE,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC;SACvC,CAAC;QACF,6EAA6E;QAC7E,6CAA6C;QAC7C,MAAM,GAAG,GAAG,kBAAkB,CAAC,KAAK,EAAE,SAAS,CAAgB,CAAC;QAChE,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;IAC3D,CAAC;CACF"}

package/dist/commands/{delete/keys.js → key/delete.js}

@@ -1,13 +1,14 @@
 import { Flags } from "@oclif/core";
 import { BaseCommand } from "../../lib/base-command.js";
-export default class DeleteKeys extends BaseCommand {
+export default class KeyDelete extends BaseCommand {
     static api = "meilisearch";
     static routes = ["DELETE /keys/{key}"];
     static keyActions = ["keys.delete"];
-    static description = "Delete an API key, which stops authenticating every request that carries it.";
+    static description = `Delete an API key.
+
+Every request that carries the key fails afterwards.`;
     static examples = [
         "<%= config.bin %> <%= command.id %> --project prod --id 52787ccd-48ff-48e5-9c4b-03cd76978a60 --yes",
-        "<%= config.bin %> <%= command.id %> --project prod --id 52787ccd-48ff-48e5-9c4b-03cd76978a60 --yes --output json",
     ];
     static flags = {
         ...BaseCommand.connectionFlags,
@@ -19,10 +20,10 @@ export default class DeleteKeys extends BaseCommand {
         ...BaseCommand.confirmFlags,
     };
     async run() {
-        const { flags } = await this.parse(DeleteKeys);
+        const { flags } = await this.parse(KeyDelete);
         // The route answers 204 with no body, so nothing goes to stdout
         // (docs/contract/output.md, Streams).
         await this.meilisearch.deleteKey(flags.id);
     }
 }
-//# sourceMappingURL=keys.js.map
+//# sourceMappingURL=delete.js.map

package/dist/commands/key/delete.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"delete.js","sourceRoot":"","sources":["../../../src/commands/key/delete.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAY,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAElE,MAAM,CAAC,OAAO,OAAO,SAAU,SAAQ,WAAW;IAChD,MAAM,CAAC,GAAG,GAAQ,aAAa,CAAC;IAEhC,MAAM,CAAC,MAAM,GAAG,CAAC,oBAAoB,CAAC,CAAC;IAEvC,MAAM,CAAC,UAAU,GAAG,CAAC,aAAa,CAAC,CAAC;IAEpC,MAAM,CAAU,WAAW,GAAG;;qDAEqB,CAAC;IAEpD,MAAM,CAAU,QAAQ,GAAG;QACzB,oGAAoG;KACrG,CAAC;IAEF,MAAM,CAAU,KAAK,GAAG;QACtB,GAAG,WAAW,CAAC,eAAe;QAC9B,EAAE,EAAE,KAAK,CAAC,MAAM,CAAC;YACf,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,oDAAoD;YACjE,SAAS,EAAE,OAAO;SACnB,CAAC;QACF,GAAG,WAAW,CAAC,YAAY;KAC5B,CAAC;IAEF,KAAK,CAAC,GAAG;QACP,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC9C,gEAAgE;QAChE,sCAAsC;QACtC,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC7C,CAAC;CACF"}

package/dist/commands/key/list.js

@@ -0,0 +1,24 @@
+import { BaseCommand } from "../../lib/base-command.js";
+import { fetchKeys } from "../../lib/clients/meilisearch.js";
+import { nextOffsetQuery } from "../../lib/pagination.js";
+export default class KeyList extends BaseCommand {
+    static api = "meilisearch";
+    static routes = ["GET /keys"];
+    static keyActions = ["keys.get"];
+    static description = `List the API keys of the instance.
+
+The answer is the API body as it is, so it carries the \`key\` field of every key it returns: credentials that work, on stdout, like any other data.`;
+    static examples = [
+        "<%= config.bin %> <%= command.id %> --project prod",
+        "<%= config.bin %> <%= command.id %> --project prod --limit 5 --offset 10",
+    ];
+    static flags = {
+        ...BaseCommand.connectionFlags,
+        ...BaseCommand.paginationFlags,
+    };
+    async run() {
+        const { flags } = await this.parse(KeyList);
+        await this.outputList((query) => fetchKeys(this.meilisearch, query), { limit: flags.limit, offset: flags.offset }, flags.all, nextOffsetQuery);
+    }
+}
+//# sourceMappingURL=list.js.map

package/dist/commands/key/list.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"list.js","sourceRoot":"","sources":["../../../src/commands/key/list.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE1D,MAAM,CAAC,OAAO,OAAO,OAAQ,SAAQ,WAAW;IAC9C,MAAM,CAAC,GAAG,GAAQ,aAAa,CAAC;IAEhC,MAAM,CAAC,MAAM,GAAG,CAAC,WAAW,CAAC,CAAC;IAE9B,MAAM,CAAC,UAAU,GAAG,CAAC,UAAU,CAAC,CAAC;IAEjC,MAAM,CAAU,WAAW,GAAG;;qJAEqH,CAAC;IAEpJ,MAAM,CAAU,QAAQ,GAAG;QACzB,oDAAoD;QACpD,0EAA0E;KAC3E,CAAC;IAEF,MAAM,CAAU,KAAK,GAAG;QACtB,GAAG,WAAW,CAAC,eAAe;QAC9B,GAAG,WAAW,CAAC,eAAe;KAC/B,CAAC;IAEF,KAAK,CAAC,GAAG;QACP,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC5C,MAAM,IAAI,CAAC,UAAU,CACnB,CAAC,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,EAC7C,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,EAC5C,KAAK,CAAC,GAAG,EACT,eAAe,CAChB,CAAC;IACJ,CAAC;CACF"}

package/dist/commands/{update/keys.js → key/update.js}

@@ -2,14 +2,16 @@ import { Flags } from "@oclif/core";
 import { BaseCommand } from "../../lib/base-command.js";
 import { readBodyWithFields } from "../../lib/input.js";
 import { asText } from "../../lib/values.js";
-export default class UpdateKeys extends BaseCommand {
+export default class KeyUpdate extends BaseCommand {
     static api = "meilisearch";
     static routes = ["PATCH /keys/{key}"];
     static keyActions = ["keys.update"];
-    static description = "Change the name or the description of an API key, the two fields the route takes, and reset one with the value null.";
+    static description = `Change the name or the description of an API key.
+
+These are the two fields the route takes. The value null resets one.`;
     static examples = [
         "<%= config.bin %> <%= command.id %> --project prod --id 52787ccd-48ff-48e5-9c4b-03cd76978a60 --name 'CI indexer'",
-        "<%= config.bin %> <%= command.id %> --project prod --id 52787ccd-48ff-48e5-9c4b-03cd76978a60 --description 'Indexes the catalog nightly' --output json",
+        "<%= config.bin %> <%= command.id %> --project prod --id 52787ccd-48ff-48e5-9c4b-03cd76978a60 --description 'Indexes the catalog nightly'",
         "<%= config.bin %> <%= command.id %> --project prod --id 52787ccd-48ff-48e5-9c4b-03cd76978a60 --description null",
     ];
     static flags = {
@@ -30,7 +32,7 @@ export default class UpdateKeys extends BaseCommand {
         ...BaseCommand.bodyInputFlags,
     };
     async run() {
-        const { flags } = await this.parse(UpdateKeys);
+        const { flags } = await this.parse(KeyUpdate);
         const fromFlags = {
             name: asText(flags.name),
             description: asText(flags.description),
@@ -39,4 +41,4 @@ export default class UpdateKeys extends BaseCommand {
         await this.output(await this.meilisearch.updateKey(flags.id, update));
     }
 }
-//# sourceMappingURL=keys.js.map
+//# sourceMappingURL=update.js.map

package/dist/commands/key/update.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"update.js","sourceRoot":"","sources":["../../../src/commands/key/update.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEpC,OAAO,EAAY,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAE7C,MAAM,CAAC,OAAO,OAAO,SAAU,SAAQ,WAAW;IAChD,MAAM,CAAC,GAAG,GAAQ,aAAa,CAAC;IAEhC,MAAM,CAAC,MAAM,GAAG,CAAC,mBAAmB,CAAC,CAAC;IAEtC,MAAM,CAAC,UAAU,GAAG,CAAC,aAAa,CAAC,CAAC;IAEpC,MAAM,CAAU,WAAW,GAAG;;qEAEqC,CAAC;IAEpE,MAAM,CAAU,QAAQ,GAAG;QACzB,kHAAkH;QAClH,0IAA0I;QAC1I,iHAAiH;KAClH,CAAC;IAEF,MAAM,CAAU,KAAK,GAAG;QACtB,GAAG,WAAW,CAAC,eAAe;QAC9B,EAAE,EAAE,KAAK,CAAC,MAAM,CAAC;YACf,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,oDAAoD;YACjE,SAAS,EAAE,OAAO;SACnB,CAAC;QACF,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC;YACjB,WAAW,EAAE,6DAA6D;YAC1E,SAAS,EAAE,QAAQ;SACpB,CAAC;QACF,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC;YACxB,WAAW,EAAE,oEAAoE;YACjF,SAAS,EAAE,QAAQ;SACpB,CAAC;QACF,GAAG,WAAW,CAAC,cAAc;KAC9B,CAAC;IAEF,KAAK,CAAC,GAAG;QACP,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC9C,MAAM,SAAS,GAA4B;YACzC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;YACxB,WAAW,EAAE,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC;SACvC,CAAC;QACF,MAAM,MAAM,GAAG,kBAAkB,CAAC,KAAK,EAAE,SAAS,CAAkB,CAAC;QACrE,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC;IACxE,CAAC;CACF"}

package/dist/commands/key/view.js

@@ -0,0 +1,26 @@
+import { Flags } from "@oclif/core";
+import { BaseCommand } from "../../lib/base-command.js";
+export default class KeyView extends BaseCommand {
+    static api = "meilisearch";
+    static routes = ["GET /keys/{key}"];
+    static keyActions = ["keys.get"];
+    static description = `Get one API key.
+
+The answer is the API body as it is, so it carries the \`key\` field: a credential that works, on stdout, like any other data.`;
+    static examples = [
+        "<%= config.bin %> <%= command.id %> --project prod --id 52787ccd-48ff-48e5-9c4b-03cd76978a60",
+    ];
+    static flags = {
+        ...BaseCommand.connectionFlags,
+        id: Flags.string({
+            required: true,
+            description: "The key to get, by its uid or by its key value.",
+            helpValue: "<key>",
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(KeyView);
+        await this.output(await this.meilisearch.getKey(flags.id));
+    }
+}
+//# sourceMappingURL=view.js.map

package/dist/commands/key/view.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"view.js","sourceRoot":"","sources":["../../../src/commands/key/view.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAY,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAElE,MAAM,CAAC,OAAO,OAAO,OAAQ,SAAQ,WAAW;IAC9C,MAAM,CAAC,GAAG,GAAQ,aAAa,CAAC;IAEhC,MAAM,CAAC,MAAM,GAAG,CAAC,iBAAiB,CAAC,CAAC;IAEpC,MAAM,CAAC,UAAU,GAAG,CAAC,UAAU,CAAC,CAAC;IAEjC,MAAM,CAAU,WAAW,GAAG;;+HAE+F,CAAC;IAE9H,MAAM,CAAU,QAAQ,GAAG;QACzB,8FAA8F;KAC/F,CAAC;IAEF,MAAM,CAAU,KAAK,GAAG;QACtB,GAAG,WAAW,CAAC,eAAe;QAC9B,EAAE,EAAE,KAAK,CAAC,MAAM,CAAC;YACf,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,iDAAiD;YAC9D,SAAS,EAAE,OAAO;SACnB,CAAC;KACH,CAAC;IAEF,KAAK,CAAC,GAAG;QACP,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC5C,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;IAC7D,CAAC;CACF"}