@meilisearch/cli 0.0.0-stage → 0.0.0

package/dist/commands/export.js

@@ -0,0 +1,67 @@
+import { Flags } from "@oclif/core";
+import { BaseCommand } from "../lib/base-command.js";
+import { triggerExport } from "../lib/clients/meilisearch.js";
+import { projectOf } from "../lib/config.js";
+import { readBodyWithFields } from "../lib/input.js";
+import { asJson, asText } from "../lib/values.js";
+/** The flags that describe the instance the data is sent to, apart in `--help`. */
+const DESTINATION = "DESTINATION";
+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.
+
+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",
+        `<%= config.bin %> <%= command.id %> --project prod --data '{"url":"http://localhost:7701","indexes":{"*":{"overrideSettings":true}}}'`,
+    ];
+    static flags = {
+        ...BaseCommand.connectionFlags,
+        url: Flags.string({
+            description: "URL of the destination instance, the one the data is sent to.",
+            helpValue: "<url>",
+            helpGroup: DESTINATION,
+        }),
+        "api-key": Flags.string({
+            description: "API key of the destination instance, the one the export writes with. --project-api-key stays the key of the source.",
+            helpValue: "<key>",
+            helpGroup: DESTINATION,
+        }),
+        "project-destination": Flags.string({
+            description: "A project of the config file, the destination: its URL and its key stand for --url and --api-key. Cannot be combined with --url. --api-key replaces its key.",
+            helpValue: "<name>",
+            helpGroup: DESTINATION,
+            exclusive: ["url"],
+        }),
+        "payload-size": Flags.string({
+            description: "Maximum size of one request sent to the destination, for example 24MiB.",
+            helpValue: "<size>",
+            helpGroup: DESTINATION,
+        }),
+        indexes: Flags.string({
+            description: 'The indexes to export and how, as JSON: an index pattern per key, its filter and overrideSettings as value. Every index by default, `{"*":{}}`.',
+            helpValue: "<json>",
+        }),
+        ...BaseCommand.bodyInputFlags,
+        ...BaseCommand.waitFlags,
+    };
+    async run() {
+        const { flags } = await this.parse(Export);
+        const name = flags["project-destination"];
+        const destination = name === undefined ? undefined : projectOf(this.configFile(), name);
+        const body = readBodyWithFields(flags, {
+            url: asText(flags.url ?? destination?.url),
+            apiKey: asText(flags["api-key"] ?? destination?.apiKey),
+            payloadSize: asText(flags["payload-size"]),
+            indexes: asJson(flags.indexes),
+        });
+        await this.outputTask(await triggerExport(this.meilisearch, body), flags);
+    }
+}
+//# sourceMappingURL=export.js.map

package/dist/commands/export.js.map

@@ -0,0 +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"}

package/dist/commands/facet-search.js

@@ -0,0 +1,87 @@
+import { Flags } from "@oclif/core";
+import { BaseCommand } from "../lib/base-command.js";
+import { readBodyWithFields } from "../lib/input.js";
+import { asJson, asNumber } from "../lib/values.js";
+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 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"}\'',
+    ];
+    static flags = {
+        ...BaseCommand.connectionFlags,
+        index: Flags.string({
+            required: true,
+            description: "The index to search the facet values in.",
+            helpValue: "<index>",
+        }),
+        "facet-name": Flags.string({
+            description: "The facet attribute to search in. It must be one of the filterable attributes of the index.",
+            helpValue: "<attribute>",
+        }),
+        "facet-query": Flags.string({
+            description: "The terms the facet values are matched against, the first word only. Omit it to return every value, up to 100.",
+            helpValue: "<query>",
+        }),
+        q: Flags.string({
+            description: "The search terms that narrow the documents the facet values are computed on, not the values themselves.",
+            helpValue: "<query>",
+        }),
+        filter: Flags.string({
+            description: "Filter expression, for example `rating > 4`. Its array-of-arrays form goes through --data.",
+            helpValue: "<filter>",
+        }),
+        "matching-strategy": Flags.option({
+            options: ["last", "all", "frequency"],
+            description: "How the terms of --q are relaxed when there are not enough results.",
+        })(),
+        "attributes-to-search-on": Flags.string({
+            description: "Restrict the search of --q to these searchable attributes, comma-separated.",
+            helpValue: "<fields>",
+        }),
+        "ranking-score-threshold": Flags.string({
+            description: "Count only the documents whose ranking score reaches this value, between 0.0 and 1.0.",
+            helpValue: "<number>",
+        }),
+        locales: Flags.string({
+            description: "ISO-639 locales of the query, comma-separated, instead of auto-detection.",
+            helpValue: "<locales>",
+        }),
+        hybrid: Flags.string({
+            description: 'Hybrid search as JSON, for example `{"embedder":"default","semanticRatio":0.5}`.',
+            helpValue: "<json>",
+        }),
+        vector: Flags.string({
+            description: "Query vector for a user-provided embedder, comma-separated numbers.",
+            helpValue: "<numbers>",
+        }),
+        "exhaustive-facet-count": Flags.boolean({
+            description: "Count the facet values exhaustively instead of estimating the counts.",
+        }),
+        ...BaseCommand.bodyInputFlags,
+    };
+    async run() {
+        const { flags } = await this.parse(FacetSearch);
+        const fromFlags = {
+            facetName: flags["facet-name"],
+            facetQuery: flags["facet-query"],
+            q: flags.q,
+            filter: flags.filter,
+            matchingStrategy: flags["matching-strategy"],
+            attributesToSearchOn: flags["attributes-to-search-on"]?.split(","),
+            rankingScoreThreshold: asNumber(flags["ranking-score-threshold"]),
+            locales: flags.locales?.split(","),
+            hybrid: asJson(flags.hybrid),
+            vector: flags.vector?.split(",").map(asNumber),
+            exhaustiveFacetCount: flags["exhaustive-facet-count"] ? true : undefined,
+        };
+        const params = readBodyWithFields(flags, fromFlags);
+        await this.output(await this.meilisearch.index(flags.index).searchForFacetValues(params));
+    }
+}
+//# sourceMappingURL=facet-search.js.map

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

@@ -0,0 +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"}

package/dist/commands/get/batches.js

@@ -0,0 +1,35 @@
+import { Flags } from "@oclif/core";
+import { BaseCommand } from "../../lib/base-command.js";
+import { nextFromQuery } from "../../lib/pagination.js";
+import { batchFilterFlags, batchFilterQuery } from "../../lib/task-filters.js";
+export default class GetBatches extends BaseCommand {
+    static api = "meilisearch";
+    static routes = ["GET /batches"];
+    static keyActions = ["tasks.get"];
+    static description = "List the batches of tasks the instance processed, narrowed by --ids, --task-ids, --statuses and the other filters of the route.";
+    static examples = [
+        "<%= config.bin %> <%= command.id %> --project prod",
+        "<%= config.bin %> <%= command.id %> --project prod --output json",
+        "<%= config.bin %> <%= command.id %> --project prod --ids 7",
+        "<%= config.bin %> <%= command.id %> --project prod --task-ids 42",
+        "<%= config.bin %> <%= command.id %> --project prod --statuses failed --index-ids movies --limit 5",
+        "<%= config.bin %> <%= command.id %> --project prod --all --output ndjson",
+    ];
+    static flags = {
+        ...BaseCommand.connectionFlags,
+        ...batchFilterFlags,
+        reverse: Flags.boolean({
+            description: "Return the batches from the oldest uid up, instead of the newest down.",
+        }),
+        ...BaseCommand.fromPaginationFlags,
+    };
+    async run() {
+        const { flags } = await this.parse(GetBatches);
+        const filters = {
+            ...batchFilterQuery(flags),
+            reverse: flags.reverse ? true : undefined,
+        };
+        await this.outputList((page) => this.meilisearch.batches.getBatches({ ...filters, ...page }), { limit: flags.limit, from: flags.from }, flags.all, nextFromQuery);
+    }
+}
+//# sourceMappingURL=batches.js.map

package/dist/commands/get/batches.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"batches.js","sourceRoot":"","sources":["../../../src/commands/get/batches.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAY,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAE/E,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,WAAW;IACjD,MAAM,CAAC,GAAG,GAAQ,aAAa,CAAC;IAEhC,MAAM,CAAC,MAAM,GAAG,CAAC,cAAc,CAAC,CAAC;IAEjC,MAAM,CAAC,UAAU,GAAG,CAAC,WAAW,CAAC,CAAC;IAElC,MAAM,CAAU,WAAW,GACzB,iIAAiI,CAAC;IAEpI,MAAM,CAAU,QAAQ,GAAG;QACzB,oDAAoD;QACpD,kEAAkE;QAClE,4DAA4D;QAC5D,kEAAkE;QAClE,mGAAmG;QACnG,0EAA0E;KAC3E,CAAC;IAEF,MAAM,CAAU,KAAK,GAAG;QACtB,GAAG,WAAW,CAAC,eAAe;QAC9B,GAAG,gBAAgB;QACnB,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC;YACrB,WAAW,EAAE,wEAAwE;SACtF,CAAC;QACF,GAAG,WAAW,CAAC,mBAAmB;KACnC,CAAC;IAEF,KAAK,CAAC,GAAG;QACP,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC/C,MAAM,OAAO,GAAG;YACd,GAAG,gBAAgB,CAAC,KAAK,CAAC;YAC1B,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;SAC1C,CAAC;QACF,MAAM,IAAI,CAAC,UAAU,CACnB,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,GAAG,OAAO,EAAE,GAAG,IAAI,EAAE,CAAC,EACtE,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,EACxC,KAAK,CAAC,GAAG,EACT,aAAa,CACd,CAAC;IACJ,CAAC;CACF"}

package/dist/commands/get/documents.js

@@ -0,0 +1,74 @@
+import { Flags } from "@oclif/core";
+import { BaseCommand } from "../../lib/base-command.js";
+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 {
+    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 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,
+        index: Flags.string({
+            required: true,
+            description: "The index to read the documents from.",
+            helpValue: "<index>",
+        }),
+        ids: Flags.string({
+            aliases: ["id"],
+            description: "Document identifiers to return, comma-separated.",
+            helpValue: "<ids>",
+        }),
+        filter: Flags.string({
+            description: "Filter expression, for example `rating > 4`. Its array-of-arrays form goes through --data.",
+            helpValue: "<filter>",
+        }),
+        fields: Flags.string({
+            description: "Document attributes to return, comma-separated. Defaults to all of them.",
+            helpValue: "<fields>",
+        }),
+        sort: Flags.string({
+            description: "Attributes to sort on, comma-separated, each as `attribute:asc` or `:desc`.",
+            helpValue: "<sort>",
+        }),
+        "retrieve-vectors": Flags.boolean({
+            description: "Include the vector embeddings of the documents that have them.",
+        }),
+        ...BaseCommand.paginationFlags,
+        ...BaseCommand.bodyInputFlags,
+    };
+    async run() {
+        const { flags } = await this.parse(GetDocuments);
+        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`." });
+        }
+        const query = { ...given };
+        if (flags.ids !== undefined)
+            query.ids = flags.ids.split(",");
+        if (flags.filter !== undefined)
+            query.filter = flags.filter;
+        if (flags.fields !== undefined)
+            query.fields = flags.fields.split(",");
+        if (flags.sort !== undefined)
+            query.sort = flags.sort.split(",");
+        if (flags["retrieve-vectors"])
+            query.retrieveVectors = true;
+        if (flags.limit !== undefined)
+            query.limit = flags.limit;
+        if (flags.offset !== undefined)
+            query.offset = flags.offset;
+        const { limit, offset, ...rest } = query;
+        await this.outputList((page) => fetchDocuments(this.meilisearch, flags.index, { ...rest, ...page }), { limit, offset }, flags.all, nextOffsetQuery);
+    }
+}
+//# sourceMappingURL=documents.js.map

package/dist/commands/get/documents.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"documents.js","sourceRoot":"","sources":["../../../src/commands/get/documents.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,mEAAmE,CAAC;IAElG,MAAM,CAAU,QAAQ,GAAG;QACzB,mEAAmE;QACnE,iFAAiF;QACjF,mGAAmG;QACnG,4GAA4G;QAC5G,yFAAyF;KAC1F,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,OAAO,EAAE,CAAC,IAAI,CAAC;YACf,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/get/health.js

@@ -0,0 +1,17 @@
+import { BaseCommand } from "../../lib/base-command.js";
+export default class GetHealth extends BaseCommand {
+    static api = "meilisearch";
+    static routes = ["GET /health"];
+    static description = "Check that the Meilisearch 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 };
+    async run() {
+        const health = await this.meilisearch.health();
+        await this.output(health);
+    }
+}
+//# sourceMappingURL=health.js.map

package/dist/commands/get/health.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"health.js","sourceRoot":"","sources":["../../../src/commands/get/health.ts"],"names":[],"mappings":"AAAA,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,aAAa,CAAC,CAAC;IAEhC,MAAM,CAAU,WAAW,GAAG,mDAAmD,CAAC;IAElF,MAAM,CAAU,QAAQ,GAAG;QACzB,oDAAoD;QACpD,kEAAkE;QAClE,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/get/indexes.js

@@ -0,0 +1,33 @@
+import { Flags } from "@oclif/core";
+import { BaseCommand } from "../../lib/base-command.js";
+import { nextOffsetQuery } from "../../lib/pagination.js";
+export default class GetIndexes extends BaseCommand {
+    static api = "meilisearch";
+    static routes = ["GET /indexes", "GET /indexes/{index_uid}"];
+    static keyActions = ["indexes.get"];
+    static description = "List the indexes of the instance, or get one with --id.";
+    static examples = [
+        "<%= config.bin %> <%= command.id %> --project prod",
+        "<%= config.bin %> <%= command.id %> --project prod --output json",
+        "<%= config.bin %> <%= command.id %> --project prod --id movies",
+        "<%= config.bin %> <%= command.id %> --project prod --limit 5 --offset 10",
+        "<%= config.bin %> <%= command.id %> --project prod --all --output ndjson",
+    ];
+    static flags = {
+        ...BaseCommand.connectionFlags,
+        id: Flags.string({
+            description: "The index to get. Without it, the command lists the indexes.",
+            helpValue: "<index>",
+        }),
+        ...BaseCommand.paginationFlags,
+    };
+    async run() {
+        const { flags } = await this.parse(GetIndexes);
+        if (flags.id !== undefined) {
+            await this.output(await this.meilisearch.getRawIndex(flags.id));
+            return;
+        }
+        await this.outputList((query) => this.meilisearch.getRawIndexes(query), { limit: flags.limit, offset: flags.offset }, flags.all, nextOffsetQuery);
+    }
+}
+//# sourceMappingURL=indexes.js.map

package/dist/commands/get/indexes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexes.js","sourceRoot":"","sources":["../../../src/commands/get/indexes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAY,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE1D,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,WAAW;IACjD,MAAM,CAAC,GAAG,GAAQ,aAAa,CAAC;IAEhC,MAAM,CAAC,MAAM,GAAG,CAAC,cAAc,EAAE,0BAA0B,CAAC,CAAC;IAE7D,MAAM,CAAC,UAAU,GAAG,CAAC,aAAa,CAAC,CAAC;IAEpC,MAAM,CAAU,WAAW,GAAG,yDAAyD,CAAC;IAExF,MAAM,CAAU,QAAQ,GAAG;QACzB,oDAAoD;QACpD,kEAAkE;QAClE,gEAAgE;QAChE,0EAA0E;QAC1E,0EAA0E;KAC3E,CAAC;IAEF,MAAM,CAAU,KAAK,GAAG;QACtB,GAAG,WAAW,CAAC,eAAe;QAC9B,EAAE,EAAE,KAAK,CAAC,MAAM,CAAC;YACf,WAAW,EAAE,8DAA8D;YAC3E,SAAS,EAAE,SAAS;SACrB,CAAC;QACF,GAAG,WAAW,CAAC,eAAe;KAC/B,CAAC;IAEF,KAAK,CAAC,GAAG;QACP,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC/C,IAAI,KAAK,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;YAC3B,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;YAChE,OAAO;QACT,CAAC;QACD,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/get/keys.js

@@ -0,0 +1,36 @@
+import { Flags } from "@oclif/core";
+import { BaseCommand } from "../../lib/base-command.js";
+import { fetchKeys } from "../../lib/clients/meilisearch.js";
+import { nextOffsetQuery } from "../../lib/pagination.js";
+export default class GetKeys extends BaseCommand {
+    static api = "meilisearch";
+    static routes = ["GET /keys", "GET /keys/{key}"];
+    static keyActions = ["keys.get"];
+    static description = `List the API keys of the instance, or get one with --id.
+
+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 --output json",
+        "<%= config.bin %> <%= command.id %> --project prod --id 52787ccd-48ff-48e5-9c4b-03cd76978a60",
+        "<%= config.bin %> <%= command.id %> --project prod --limit 5 --offset 10",
+        "<%= config.bin %> <%= command.id %> --project prod --all --output ndjson",
+    ];
+    static flags = {
+        ...BaseCommand.connectionFlags,
+        id: Flags.string({
+            description: "The key to get, by its uid or by its key value. Without it, the command lists the keys.",
+            helpValue: "<key>",
+        }),
+        ...BaseCommand.paginationFlags,
+    };
+    async run() {
+        const { flags } = await this.parse(GetKeys);
+        if (flags.id !== undefined) {
+            await this.output(await this.meilisearch.getKey(flags.id));
+            return;
+        }
+        await this.outputList((query) => fetchKeys(this.meilisearch, query), { limit: flags.limit, offset: flags.offset }, flags.all, nextOffsetQuery);
+    }
+}
+//# sourceMappingURL=keys.js.map

package/dist/commands/get/keys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"keys.js","sourceRoot":"","sources":["../../../src/commands/get/keys.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,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,EAAE,iBAAiB,CAAC,CAAC;IAEjD,MAAM,CAAC,UAAU,GAAG,CAAC,UAAU,CAAC,CAAC;IAEjC,MAAM,CAAU,WAAW,GAAG;;qJAEqH,CAAC;IAEpJ,MAAM,CAAU,QAAQ,GAAG;QACzB,oDAAoD;QACpD,kEAAkE;QAClE,8FAA8F;QAC9F,0EAA0E;QAC1E,0EAA0E;KAC3E,CAAC;IAEF,MAAM,CAAU,KAAK,GAAG;QACtB,GAAG,WAAW,CAAC,eAAe;QAC9B,EAAE,EAAE,KAAK,CAAC,MAAM,CAAC;YACf,WAAW,EACT,yFAAyF;YAC3F,SAAS,EAAE,OAAO;SACnB,CAAC;QACF,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,IAAI,KAAK,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;YAC3B,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;YAC3D,OAAO;QACT,CAAC;QACD,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/get/projects.js

@@ -0,0 +1,40 @@
+import { Flags } from "@oclif/core";
+import { BaseCommand } from "../../lib/base-command.js";
+import { getApiV2Projects, getApiV2ProjectsById, } from "../../lib/clients/management/generated/sdk.gen.js";
+export default class GetProjects extends BaseCommand {
+    static api = "management";
+    static routes = ["GET /api/v2/projects", "GET /api/v2/projects/{id}"];
+    static description = "List the Meilisearch Cloud projects the token sees, or get one with --id or --project.";
+    static examples = [
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> --output json",
+        "<%= config.bin %> <%= command.id %> --team-id 12",
+        "<%= config.bin %> <%= command.id %> --id 343",
+        "<%= config.bin %> <%= command.id %> --project prod",
+        "<%= config.bin %> <%= command.id %> --output ndjson",
+    ];
+    static flags = {
+        ...BaseCommand.cloudProjectFlags,
+        id: Flags.integer({
+            description: "The project to get, or give --project <name> and its cloud.id from the config file. Without either, the command lists the projects.",
+            helpValue: "<id>",
+        }),
+        "team-id": Flags.integer({
+            description: "Only the projects of this team. Ignored with --id.",
+            helpValue: "<id>",
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(GetProjects);
+        if (flags.id === undefined && flags.project === undefined) {
+            // One page and no paging flags yet (output.md, "Pagination").
+            await this.outputList((query) => getApiV2Projects({ client: this.managementClient, query }), { teamId: flags["team-id"] }, false, () => undefined);
+            return;
+        }
+        await this.output(await getApiV2ProjectsById({
+            client: this.managementClient,
+            path: { id: this.cloudProjectId(flags.id) },
+        }));
+    }
+}
+//# sourceMappingURL=projects.js.map

package/dist/commands/get/projects.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"projects.js","sourceRoot":"","sources":["../../../src/commands/get/projects.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAY,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,EACL,gBAAgB,EAChB,oBAAoB,GACrB,MAAM,mDAAmD,CAAC;AAE3D,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,WAAW;IAClD,MAAM,CAAC,GAAG,GAAQ,YAAY,CAAC;IAE/B,MAAM,CAAC,MAAM,GAAG,CAAC,sBAAsB,EAAE,2BAA2B,CAAC,CAAC;IAEtE,MAAM,CAAU,WAAW,GACzB,wFAAwF,CAAC;IAE3F,MAAM,CAAU,QAAQ,GAAG;QACzB,qCAAqC;QACrC,mDAAmD;QACnD,kDAAkD;QAClD,8CAA8C;QAC9C,oDAAoD;QACpD,qDAAqD;KACtD,CAAC;IAEF,MAAM,CAAU,KAAK,GAAG;QACtB,GAAG,WAAW,CAAC,iBAAiB;QAChC,EAAE,EAAE,KAAK,CAAC,OAAO,CAAC;YAChB,WAAW,EACT,qIAAqI;YACvI,SAAS,EAAE,MAAM;SAClB,CAAC;QACF,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC;YACvB,WAAW,EAAE,oDAAoD;YACjE,SAAS,EAAE,MAAM;SAClB,CAAC;KACH,CAAC;IAEF,KAAK,CAAC,GAAG;QACP,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAChD,IAAI,KAAK,CAAC,EAAE,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1D,8DAA8D;YAC9D,MAAM,IAAI,CAAC,UAAU,CACnB,CAAC,KAAK,EAAE,EAAE,CAAC,gBAAgB,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,gBAAgB,EAAE,KAAK,EAAE,CAAC,EACrE,EAAE,MAAM,EAAE,KAAK,CAAC,SAAS,CAAC,EAAE,EAC5B,KAAK,EACL,GAAG,EAAE,CAAC,SAAS,CAChB,CAAC;YACF,OAAO;QACT,CAAC;QACD,MAAM,IAAI,CAAC,MAAM,CACf,MAAM,oBAAoB,CAAC;YACzB,MAAM,EAAE,IAAI,CAAC,gBAAgB;YAC7B,IAAI,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE;SAC5C,CAAC,CACH,CAAC;IACJ,CAAC;CACF"}

package/dist/commands/get/settings.js

@@ -0,0 +1,25 @@
+import { Flags } from "@oclif/core";
+import { BaseCommand } from "../../lib/base-command.js";
+export default class GetSettings extends BaseCommand {
+    static api = "meilisearch";
+    static routes = ["GET /indexes/{index_uid}/settings"];
+    static keyActions = ["settings.get"];
+    static description = "Get every setting of an index, each with its current value or its default.";
+    static examples = [
+        "<%= config.bin %> <%= command.id %> --project prod --index movies",
+        "<%= config.bin %> <%= command.id %> --project prod --index movies --output json",
+    ];
+    static flags = {
+        ...BaseCommand.connectionFlags,
+        index: Flags.string({
+            required: true,
+            description: "The index to read the settings of.",
+            helpValue: "<index>",
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(GetSettings);
+        await this.output(await this.meilisearch.index(flags.index).getSettings());
+    }
+}
+//# sourceMappingURL=settings.js.map

package/dist/commands/get/settings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"settings.js","sourceRoot":"","sources":["../../../src/commands/get/settings.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,mCAAmC,CAAC,CAAC;IAEtD,MAAM,CAAC,UAAU,GAAG,CAAC,cAAc,CAAC,CAAC;IAErC,MAAM,CAAU,WAAW,GACzB,4EAA4E,CAAC;IAE/E,MAAM,CAAU,QAAQ,GAAG;QACzB,mEAAmE;QACnE,iFAAiF;KAClF,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,oCAAoC;YACjD,SAAS,EAAE,SAAS;SACrB,CAAC;KACH,CAAC;IAEF,KAAK,CAAC,GAAG;QACP,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAChD,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;IAC7E,CAAC;CACF"}

package/dist/commands/get/stats.js

@@ -0,0 +1,37 @@
+import { Flags } from "@oclif/core";
+import { BaseCommand } from "../../lib/base-command.js";
+import { fetchStats } from "../../lib/clients/meilisearch.js";
+export default class GetStats extends BaseCommand {
+    static api = "meilisearch";
+    static routes = ["GET /stats", "GET /indexes/{index_uid}/stats"];
+    static keyActions = ["stats.get"];
+    static description = "Get the statistics of the whole instance, or those of one index with --index.";
+    static examples = [
+        "<%= config.bin %> <%= command.id %> --project prod",
+        "<%= config.bin %> <%= command.id %> --project prod --output json",
+        "<%= config.bin %> <%= command.id %> --project prod --index movies",
+        "<%= config.bin %> <%= command.id %> --project prod --index movies --size-format human --show-internal-database-sizes",
+    ];
+    static flags = {
+        ...BaseCommand.connectionFlags,
+        index: Flags.string({
+            description: "The index to read the statistics of. Without it, the whole instance.",
+            helpValue: "<index>",
+        }),
+        "show-internal-database-sizes": Flags.boolean({
+            description: "Add internalDatabaseSizes to the response, the size of each internal database.",
+        }),
+        "size-format": Flags.option({
+            options: ["raw", "human"],
+            description: "How the sizes are written: raw (default), a number of bytes, or human, a string with its unit.",
+        })(),
+    };
+    async run() {
+        const { flags } = await this.parse(GetStats);
+        await this.output(await fetchStats(this.meilisearch, flags.index, {
+            showInternalDatabaseSizes: flags["show-internal-database-sizes"] ? true : undefined,
+            sizeFormat: flags["size-format"],
+        }));
+    }
+}
+//# sourceMappingURL=stats.js.map

package/dist/commands/get/stats.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stats.js","sourceRoot":"","sources":["../../../src/commands/get/stats.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAY,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAC;AAE9D,MAAM,CAAC,OAAO,OAAO,QAAS,SAAQ,WAAW;IAC/C,MAAM,CAAC,GAAG,GAAQ,aAAa,CAAC;IAEhC,MAAM,CAAC,MAAM,GAAG,CAAC,YAAY,EAAE,gCAAgC,CAAC,CAAC;IAEjE,MAAM,CAAC,UAAU,GAAG,CAAC,WAAW,CAAC,CAAC;IAElC,MAAM,CAAU,WAAW,GACzB,+EAA+E,CAAC;IAElF,MAAM,CAAU,QAAQ,GAAG;QACzB,oDAAoD;QACpD,kEAAkE;QAClE,mEAAmE;QACnE,sHAAsH;KACvH,CAAC;IAEF,MAAM,CAAU,KAAK,GAAG;QACtB,GAAG,WAAW,CAAC,eAAe;QAC9B,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC;YAClB,WAAW,EAAE,sEAAsE;YACnF,SAAS,EAAE,SAAS;SACrB,CAAC;QACF,8BAA8B,EAAE,KAAK,CAAC,OAAO,CAAC;YAC5C,WAAW,EAAE,gFAAgF;SAC9F,CAAC;QACF,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC;YAC1B,OAAO,EAAE,CAAC,KAAK,EAAE,OAAO,CAAU;YAClC,WAAW,EACT,gGAAgG;SACnG,CAAC,EAAE;KACL,CAAC;IAEF,KAAK,CAAC,GAAG;QACP,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC7C,MAAM,IAAI,CAAC,MAAM,CACf,MAAM,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,KAAK,EAAE;YAC9C,yBAAyB,EAAE,KAAK,CAAC,8BAA8B,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;YACnF,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC;SACjC,CAAC,CACH,CAAC;IACJ,CAAC;CACF"}

package/dist/commands/get/tasks.js

@@ -0,0 +1,35 @@
+import { Flags } from "@oclif/core";
+import { BaseCommand } from "../../lib/base-command.js";
+import { nextFromQuery } from "../../lib/pagination.js";
+import { taskFilterFlags, taskFilterQuery } from "../../lib/task-filters.js";
+export default class GetTasks extends BaseCommand {
+    static api = "meilisearch";
+    static routes = ["GET /tasks"];
+    static keyActions = ["tasks.get"];
+    static description = "List the tasks of the instance, narrowed by --ids, --statuses, --types and the other filters of the route.";
+    static examples = [
+        "<%= config.bin %> <%= command.id %> --project prod",
+        "<%= config.bin %> <%= command.id %> --project prod --output json",
+        "<%= config.bin %> <%= command.id %> --project prod --ids 42",
+        "<%= config.bin %> <%= command.id %> --project prod --statuses failed,canceled --limit 5",
+        "<%= config.bin %> <%= command.id %> --project prod --index-ids movies --types documentAdditionOrUpdate",
+        "<%= config.bin %> <%= command.id %> --project prod --all --output ndjson",
+    ];
+    static flags = {
+        ...BaseCommand.connectionFlags,
+        ...taskFilterFlags,
+        reverse: Flags.boolean({
+            description: "Return the tasks from the oldest uid up, instead of the newest down.",
+        }),
+        ...BaseCommand.fromPaginationFlags,
+    };
+    async run() {
+        const { flags } = await this.parse(GetTasks);
+        const filters = {
+            ...taskFilterQuery(flags),
+            reverse: flags.reverse ? true : undefined,
+        };
+        await this.outputList((page) => this.meilisearch.tasks.getTasks({ ...filters, ...page }), { limit: flags.limit, from: flags.from }, flags.all, nextFromQuery);
+    }
+}
+//# sourceMappingURL=tasks.js.map

package/dist/commands/get/tasks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tasks.js","sourceRoot":"","sources":["../../../src/commands/get/tasks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAY,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAE7E,MAAM,CAAC,OAAO,OAAO,QAAS,SAAQ,WAAW;IAC/C,MAAM,CAAC,GAAG,GAAQ,aAAa,CAAC;IAEhC,MAAM,CAAC,MAAM,GAAG,CAAC,YAAY,CAAC,CAAC;IAE/B,MAAM,CAAC,UAAU,GAAG,CAAC,WAAW,CAAC,CAAC;IAElC,MAAM,CAAU,WAAW,GACzB,4GAA4G,CAAC;IAE/G,MAAM,CAAU,QAAQ,GAAG;QACzB,oDAAoD;QACpD,kEAAkE;QAClE,6DAA6D;QAC7D,yFAAyF;QACzF,wGAAwG;QACxG,0EAA0E;KAC3E,CAAC;IAEF,MAAM,CAAU,KAAK,GAAG;QACtB,GAAG,WAAW,CAAC,eAAe;QAC9B,GAAG,eAAe;QAClB,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC;YACrB,WAAW,EAAE,sEAAsE;SACpF,CAAC;QACF,GAAG,WAAW,CAAC,mBAAmB;KACnC,CAAC;IAEF,KAAK,CAAC,GAAG;QACP,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC7C,MAAM,OAAO,GAAG;YACd,GAAG,eAAe,CAAC,KAAK,CAAC;YACzB,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;SAC1C,CAAC;QACF,MAAM,IAAI,CAAC,UAAU,CACnB,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,GAAG,OAAO,EAAE,GAAG,IAAI,EAAE,CAAC,EAClE,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,EACxC,KAAK,CAAC,GAAG,EACT,aAAa,CACd,CAAC;IACJ,CAAC;CACF"}

package/dist/commands/get/version.js

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

package/dist/commands/get/version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../../../src/commands/get/version.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAElE,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,WAAW;IACjD,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,GACzB,iFAAiF,CAAC;IAEpF,MAAM,CAAU,QAAQ,GAAG;QACzB,oDAAoD;QACpD,kEAAkE;KACnE,CAAC;IAEF,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/multi-search.js

@@ -0,0 +1,39 @@
+import { Flags } from "@oclif/core";
+import { BaseCommand } from "../lib/base-command.js";
+import { readJsonObjectBody } from "../lib/input.js";
+import { asJson } from "../lib/values.js";
+export default class MultiSearch extends BaseCommand {
+    static api = "meilisearch";
+    static routes = ["POST /multi-search"];
+    static keyActions = ["search"];
+    static description = "Run several search queries in one request, each naming its index in --queries, returned side by side or merged into one ranked list with --federation.";
+    static examples = [
+        '<%= config.bin %> <%= command.id %> --project prod --queries \'[{"indexUid":"movies","q":"nosferatu"},{"indexUid":"books","q":"nosferatu"}]\'',
+        '<%= config.bin %> <%= command.id %> --project prod --queries \'[{"indexUid":"movies","q":"nosferatu"}]\' --output json',
+        '<%= config.bin %> <%= command.id %> --project prod --queries \'[{"indexUid":"movies","q":"horror"},{"indexUid":"books","q":"horror"}]\' --federation \'{"limit":5}\'',
+        "cat queries.json | <%= config.bin %> <%= command.id %> --project prod --file -",
+    ];
+    static flags = {
+        ...BaseCommand.connectionFlags,
+        queries: Flags.string({
+            description: 'The search queries as a JSON array, each one an index to search and its search parameters: `[{"indexUid":"movies","q":"nosferatu"}]`.',
+            helpValue: "<json>",
+        }),
+        federation: Flags.string({
+            description: 'Merge the hits of every query into one ranked list, as JSON: `{}` for the defaults, `{"limit":5}` to narrow it. Without it each query answers its own envelope.',
+            helpValue: "<json>",
+        }),
+        ...BaseCommand.bodyInputFlags,
+    };
+    async run() {
+        const { flags } = await this.parse(MultiSearch);
+        // The body of --file or --data first, then the flags, which override a field of it (rule 8).
+        const params = { ...readJsonObjectBody(flags) };
+        if (flags.queries !== undefined)
+            params.queries = asJson(flags.queries);
+        if (flags.federation !== undefined)
+            params.federation = asJson(flags.federation);
+        await this.output(await this.meilisearch.multiSearch(params));
+    }
+}
+//# sourceMappingURL=multi-search.js.map