From a1b4ba0d0a47aeef16e49fb98173caaf12bd6589 Mon Sep 17 00:00:00 2001 From: curquiza Date: Mon, 9 Nov 2026 17:56:20 +0100 Subject: [PATCH 1/2] Add the code samples of the Meilisearch documentation Each sample is the meili version of the cURL sample of the same key in the documentation. Rule 19 of CLAUDE.md and the pull request template ask to keep them up to date, and a contract test checks that every command and flag they use exists. --- .claude/skills/add-command/SKILL.md | 4 +- .code-samples.meilisearch.yaml | 1519 +++++++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 1 + CLAUDE.md | 8 +- CONTRIBUTING.md | 6 +- test/contract/docs.test.ts | 50 +- 6 files changed, 1575 insertions(+), 13 deletions(-) create mode 100644 .code-samples.meilisearch.yaml diff --git a/.claude/skills/add-command/SKILL.md b/.claude/skills/add-command/SKILL.md index bad85ec0..fcd1441c 100644 --- a/.claude/skills/add-command/SKILL.md +++ b/.claude/skills/add-command/SKILL.md @@ -98,9 +98,10 @@ Run `pnpm test` once to write the snapshots, then read the `.snap` file: the JSO A Management API command has none: Meilisearch Cloud does not run locally (`docs/contract/testing.md`). For a Meilisearch command, copy `test/integration/meilisearch/health.test.ts` or `index-list.test.ts`. The file starts with `const meilisearchUp = await meilisearchAvailable()` and wraps everything in `describe.skipIf(!meilisearchUp)`. It runs the built binary with `runBinary([...])` against `MEILISEARCH_URL` and `MASTER_KEY` from `setup.ts`, with `--project-url` and `--project-api-key`, never a project of the developer's config file. Fixtures (an index, documents) are created with the SDK under a random suffix and deleted in `afterAll`, so the suite can run in parallel and never depends on existing data. A management command has no integration test (`docs/contract/testing.md`, section 2): its handlers in `test/helpers/management-handlers.ts` follow `openapi/management.json`, and what the document does not say is reported to the user as a documentation gap, never guessed. -## 6. Manifest, changeset +## 6. Manifest, code samples, changeset - `pnpm gen:manifest`: builds and rewrites `oclif.manifest.json`. The file is committed; CI fails if it differs from the code. The `meili schema` snapshot in `test/contract/__snapshots__/` changes with it: update it on purpose with `pnpm test -u`, and read the diff. +- Code samples, by rule 19 of `CLAUDE.md`: find the cURL samples of the routes of the command in `.code-samples.meilisearch.yaml` of the `meilisearch/documentation` repository. Add one `meili` sample per cURL sample to `.code-samples.meilisearch.yaml` of this repository, under the same key. Copy the shape of the samples already there: the `meili config set` first, then the command with `--project PROJECT_NAME`. Run each new sample against the local Meilisearch before you commit it. - Changeset: a new command is visible to users of the package, so it needs a line. Write `.changeset/add-.md` by hand, by the rules of `.changeset/README.md`: the interactive `pnpm changeset` cannot be answered by an agent. The line names the command, without its flags: they live in `--help`. It ends with the link to the pull request, added once the pull request is open. ```md @@ -138,6 +139,7 @@ So that a red `pnpm test` reads as a message, not as flakiness: - every command has a description and an example; every flag has a description, and a flag with a value a `helpValue` or options - every command in `src/commands/` has its test file in `test/commands/` - every path, `pnpm` script and `BaseCommand` member the guides cite exists; a path cited before it exists is listed as planned in `test/contract/docs.test.ts`, and the test asks to remove it from the list once it exists +- every sample of `.code-samples.meilisearch.yaml` runs a command that exists, with flags that the command declares - every command exposes the global flags of `commands.md`; a parent path parameter is a required flag when every route of the command takes it; no command has a positional argument - the `meili schema` index is a snapshot, and so is one command in full - a variable that doubles a flag is named `MEILI_` plus the flag name (rule 14) diff --git a/.code-samples.meilisearch.yaml b/.code-samples.meilisearch.yaml new file mode 100644 index 00000000..b6a8793a --- /dev/null +++ b/.code-samples.meilisearch.yaml @@ -0,0 +1,1519 @@ +# The `meili` samples of the Meilisearch documentation. +# The documentation fetches this file on build. It shows each sample in a CLI tab, +# next to the cURL sample of the same key. A key is the key of the documentation. +# Only the commands that the CLI implements have a sample. See CLAUDE.md, rule 19. +--- +get_one_index_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili index view --project PROJECT_NAME --id movies +list_all_indexes_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili index list --project PROJECT_NAME --limit 3 +create_an_index_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili index add --project PROJECT_NAME --id movies --primary-key id +update_an_index_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili index update --project PROJECT_NAME --id movies --primary-key id +delete_an_index_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili index delete --project PROJECT_NAME --id movies --yes +get_one_document_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili document view --project PROJECT_NAME --index movies --id 25684 \ + --fields id,title,poster,release_date +get_documents_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili document list --project PROJECT_NAME --index movies \ + --limit 2 --filter genres=action +add_or_replace_documents_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili document add --project PROJECT_NAME --index movies \ + --data '[ + { + "id": 287947, + "title": "Shazam", + "poster": "https://image.tmdb.org/t/p/w1280/xnopI5Xtky18MPhK40cZAGAOVeV.jpg", + "overview": "A boy is given the ability to become an adult superhero in times of need with a single magic word.", + "release_date": "2019-03-23" + } + ]' +add_or_update_documents_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili document update --project PROJECT_NAME --index movies \ + --data '[{"id":287947,"title":"Shazam ⚡️","genres":"comedy"}]' +delete_all_documents_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili document delete --project PROJECT_NAME --index movies --all --yes +delete_one_document_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili document delete --project PROJECT_NAME --index movies --ids 25684 --yes +delete_documents_by_batch_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili document delete --project PROJECT_NAME --index movies \ + --ids 23488,153738,437035,363869 --yes +search_post_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index movies --q 'american ninja' +search_get_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index movies --q 'american ninja' +get_all_tasks_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili task list --project PROJECT_NAME +get_task_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili task view --project PROJECT_NAME --id 1 +get_all_tasks_paginating_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili task list --project PROJECT_NAME --limit 2 --from 10 +get_all_tasks_paginating_2: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili task list --project PROJECT_NAME --limit 2 --from 8 +get_one_key_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key MASTER_KEY + + meili key view --project PROJECT_NAME --id 6062abda-a5aa-4414-ac91-ecd7944c0f8d +get_all_keys_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key MASTER_KEY + + meili key list --project PROJECT_NAME --limit 3 +create_a_key_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key MASTER_KEY + + meili key add --project PROJECT_NAME \ + --description 'Add documents: Products API key' --actions documents.add \ + --indexes products --expires-at 2042-04-02T00:42:42Z +update_a_key_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key MASTER_KEY + + meili key update --project PROJECT_NAME --id 6062abda-a5aa-4414-ac91-ecd7944c0f8d \ + --name 'Products/Reviews API key' \ + --description 'Manage documents: Products/Reviews API key' +delete_a_key_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key MASTER_KEY + + meili key delete --project PROJECT_NAME --id 6062abda-a5aa-4414-ac91-ecd7944c0f8d \ + --yes +get_settings_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings view --project PROJECT_NAME --index movies +update_settings_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index movies \ + --ranking-rules words,typo,proximity,attributeRank,sort,wordPosition,exactness,release_date:desc,rank:desc \ + --distinct-attribute movie_id --searchable-attributes title,overview,genres \ + --displayed-attributes title,overview,genres,release_date \ + --stop-words the,a,an --sortable-attributes title,release_date \ + --synonyms '{"wolverine":["xmen","logan"],"logan":["wolverine"]}' \ + --typo-tolerance '{ + "minWordSizeForTypos": { "oneTypo": 8, "twoTypos": 10 }, + "disableOnAttributes": ["title"] + }' \ + --pagination '{"maxTotalHits":5000}' --faceting '{"maxValuesPerFacet":200}' \ + --search-cutoff-ms 150 +reset_settings_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings delete --project PROJECT_NAME --index movies --yes +update_synonyms_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index movies \ + --synonyms '{ + "wolverine": ["xmen", "logan"], + "logan": ["wolverine", "xmen"], + "wow": ["world of warcraft"] + }' +reset_synonyms_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index movies --synonyms null +update_stop_words_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index movies \ + --stop-words the,of,to +reset_stop_words_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index movies --stop-words null +update_ranking_rules_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index movies \ + --ranking-rules words,typo,proximity,attributeRank,sort,wordPosition,exactness,release_date:asc,rank:desc +reset_ranking_rules_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index movies --ranking-rules null +update_distinct_attribute_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index shoes \ + --distinct-attribute skuid +reset_distinct_attribute_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index shoes \ + --distinct-attribute null +update_filterable_attributes_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index movies \ + --data '{ + "filterableAttributes": [ + "genres", + "director", + { + "attributePatterns": ["*_ratings"], + "features": { + "facetSearch": false, + "filter": { "equality": true, "comparison": false } + } + } + ] + }' +reset_filterable_attributes_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index movies \ + --filterable-attributes null +update_searchable_attributes_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index movies \ + --searchable-attributes title,overview,genres +reset_searchable_attributes_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index movies \ + --searchable-attributes null +update_displayed_attributes_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index movies \ + --displayed-attributes title,overview,genres,release_date +reset_displayed_attributes_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index movies \ + --displayed-attributes null +update_sortable_attributes_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index books \ + --sortable-attributes price,author +reset_sortable_attributes_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index books \ + --sortable-attributes null +update_typo_tolerance_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index books \ + --typo-tolerance '{ + "minWordSizeForTypos": { "oneTypo": 4, "twoTypos": 10 }, + "disableOnAttributes": ["title"] + }' +reset_typo_tolerance_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index books --typo-tolerance null +update_pagination_settings_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index books \ + --pagination '{"maxTotalHits":100}' +reset_pagination_settings_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index books --pagination null +update_faceting_settings_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index books \ + --faceting '{ + "maxValuesPerFacet": 2, + "sortFacetValuesBy": { + "*": "alpha", + "genres": "count", + "language": "sampledCount" + } + }' +update_faceting_settings_max_values_per_facet_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index books \ + --faceting '{"maxValuesPerFacet":20}' +reset_faceting_settings_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index books --faceting null +update_separator_tokens_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index articles \ + --separator-tokens '|,…' +reset_separator_tokens_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index articles \ + --separator-tokens null +update_non_separator_tokens_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index articles \ + --non-separator-tokens '@,#' +reset_non_separator_tokens_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index articles \ + --non-separator-tokens null +update_dictionary_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index books \ + --dictionary 'J. R. R.,W. E. B.' +reset_dictionary_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index books --dictionary null +update_proximity_precision_settings_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index books \ + --proximity-precision byAttribute +reset_proximity_precision_settings_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index books \ + --proximity-precision null +update_facet_search_settings_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index INDEX_UID \ + --facet-search false +reset_facet_search_settings_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index INDEX_UID \ + --facet-search null +update_prefix_search_settings_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index INDEX_UID \ + --prefix-search disabled +reset_prefix_search_settings_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index INDEX_UID \ + --prefix-search null +update_search_cutoff_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index movies \ + --search-cutoff-ms 150 +reset_search_cutoff_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index movies \ + --search-cutoff-ms null +update_localized_attribute_settings_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index INDEX_NAME \ + --localized-attributes '[{"locales":["jpn"],"attributePatterns":["*_ja"]}]' +multilingual_dataset_guide_update_localized_attributes_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index INDEX_NAME \ + --localized-attributes '[ + { "attributePatterns": ["*_en"], "locales": ["eng"] }, + { "attributePatterns": ["*_de"], "locales": ["deu"] }, + { "attributePatterns": ["*_fr"], "locales": ["fra"] } + ]' +reset_localized_attribute_settings_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index INDEX_NAME \ + --localized-attributes null +update_embedders_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index INDEX_NAME \ + --embedders '{ + "default": { + "source": "openAi", + "apiKey": "OPEN_AI_API_KEY", + "model": "text-embedding-3-small", + "documentTemplate": "A document titled '\''{{doc.title}}'\'' whose description starts with {{doc.overview|truncatewords: 20}}" + } + }' +update_embedders_distribution_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key MEILISEARCH_KEY + + meili settings update --project PROJECT_NAME --index INDEX_NAME \ + --embedders '{ + "default": { + "source": "openAi", + "model": "text-embedding-3-small", + "distribution": { "mean": 0.7, "sigma": 0.3 } + } + }' +reset_embedders_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index INDEX_NAME --embedders null +update_chat_settings_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index INDEX_NAME \ + --chat '{ + "description": "An index of movies.", + "documentTemplate": "A movie titled '\''{{doc.title}}'\'' released in {{ doc.release_date }}", + "documentTemplateMaxBytes": 400 + }' +reset_chat_settings_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index INDEX_NAME --chat null +delete_tasks_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili task delete --project PROJECT_NAME --ids 1,2 --yes +cancel_tasks_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili task cancel --project PROJECT_NAME --ids 1,2 +multi_search_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili multi-search --project PROJECT_NAME \ + --queries '[ + { "indexUid": "movies", "q": "pooh", "limit": 5 }, + { "indexUid": "movies", "q": "nemo", "limit": 5 }, + { "indexUid": "movie_ratings", "q": "us" } + ]' +get_documents_post_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili document list --project PROJECT_NAME --index books \ + --filter '(rating > 3 AND (genres = Adventure OR genres = Fiction)) AND language = English' \ + --fields title,genres,rating,language --limit 3 +get_documents_post_with_filter_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili document list --project PROJECT_NAME --index movies \ + --filter 'genres = Action AND rating > 8' +delete_documents_by_filter_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili document delete --project PROJECT_NAME --index movies \ + --filter 'genres = action OR genres = adventure' --yes +facet_search_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili facet-search --project PROJECT_NAME --index books \ + --facet-query fiction --facet-name genres --filter 'rating > 3' +get_all_batches_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili batch list --project PROJECT_NAME +get_batch_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili batch view --project PROJECT_NAME --id 0 +get_similar_post_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key DEFAULT_SEARCH_API_KEY + + meili similar --project PROJECT_NAME --index INDEX_NAME \ + --id TARGET_DOCUMENT_ID --embedder EMBEDDER_NAME +get_similar_get_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili similar --project PROJECT_NAME --index INDEX_NAME \ + --id TARGET_DOCUMENT_ID --embedder EMBEDDER_NAME +export_post_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili export --project PROJECT_NAME \ + --url TARGET_INSTANCE_URL --indexes '{"*":{"overrideSettings":true}}' +get_index_stats_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili stats --project PROJECT_NAME --index movies +get_indexes_stats_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili stats --project PROJECT_NAME +get_health_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili health --project PROJECT_NAME +get_version_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili info --project PROJECT_NAME +distinct_attribute_guide_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index jackets \ + --distinct-attribute product_id +field_properties_guide_displayed_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index movies \ + --displayed-attributes title,overview,genres,release_date +filtering_guide_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index movie_ratings \ + --q Avengers --filter 'release_date > 795484800' +filtering_guide_2: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index movie_ratings \ + --q Batman \ + --filter 'release_date > 795484800 AND (director = "Tim Burton" OR director = "Christopher Nolan")' +filtering_guide_3: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index movie_ratings \ + --q 'Planet of the Apes' \ + --filter 'release_date > 1577884550 AND (NOT director = "Tim Burton")' +filtering_guide_nested_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index movie_ratings \ + --q thriller --filter 'rating.users >= 90' +add_movies_json_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili document add --project PROJECT_NAME --index movies --file movies.json +getting_started_add_documents: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key aSampleMasterKey + + meili document add --project PROJECT_NAME --index movies \ + --primary-key id --file movies.json +getting_started_check_task_status: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key aSampleMasterKey + + meili task view --project PROJECT_NAME --id 0 +getting_started_search: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key aSampleMasterKey + + meili search --project PROJECT_NAME --index movies --q botman +authorization_header_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key MASTER_KEY + + meili key list --project PROJECT_NAME +sorting_guide_update_sortable_attributes_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index books \ + --sortable-attributes author,price +sorting_guide_update_ranking_rules_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index books \ + --ranking-rules words,sort,typo,proximity,attributeRank,wordPosition,exactness +sorting_guide_sort_nested_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index books \ + --q 'science fiction' --sort rating.users:asc +sorting_guide_sort_parameter_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index books \ + --q 'science fiction' --sort price:asc +sorting_guide_sort_parameter_2: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index books --q butler --sort author:desc +geosearch_guide_filter_settings_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index restaurants \ + --filterable-attributes _geo +geosearch_guide_filter_settings_2: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index neighborhoods \ + --filterable-attributes _geojson +geosearch_guide_filter_usage_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index restaurants \ + --filter '_geoRadius(45.472735, 9.184019, 2000)' +geosearch_guide_filter_usage_2: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index restaurants \ + --filter '_geoRadius(45.472735, 9.184019, 2000) AND type = pizza' +geosearch_guide_filter_usage_3: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index restaurants \ + --filter '_geoBoundingBox([45.494181, 9.214024], [45.449484, 9.179175])' +geosearch_guide_sort_settings_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index restaurants \ + --sortable-attributes _geo +geosearch_guide_sort_usage_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index restaurants \ + --data '{"sort":["_geoPoint(48.8561446,2.2978204):asc"]}' +geosearch_guide_sort_usage_2: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index restaurants \ + --data '{ + "sort": ["_geoPoint(48.8561446,2.2978204):asc", "rating:desc"] + }' +basic_security_tutorial_admin_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key DEFAULT_ADMIN_API_KEY + + meili index add --project PROJECT_NAME --id medical_records --primary-key id +basic_security_tutorial_search_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key DEFAULT_SEARCH_API_KEY + + meili search --project PROJECT_NAME --index medical_records --q appointments +primary_field_guide_create_index_primary_key: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili index add --project PROJECT_NAME --id books --primary-key reference_number +primary_field_guide_add_document_primary_key: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili document add --project PROJECT_NAME --index books \ + --primary-key reference_number \ + --data '[ + { + "reference_number": 287947, + "title": "Diary of a Wimpy Kid", + "author": "Jeff Kinney", + "genres": ["comedy", "humor"], + "price": 5 + } + ]' +primary_field_guide_update_document_primary_key: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili index update --project PROJECT_NAME --id books --primary-key title +tenant_token_guide_search_no_sdk_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key TENANT_TOKEN + + meili search --project PROJECT_NAME --index patient_medical_records +typo_tolerance_guide_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index movies \ + --typo-tolerance '{"enabled":false}' +typo_tolerance_guide_2: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index movies \ + --typo-tolerance '{"disableOnAttributes":["title"]}' +typo_tolerance_guide_3: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index movies \ + --typo-tolerance '{"disableOnWords":["shrek"]}' +typo_tolerance_guide_4: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index movies \ + --typo-tolerance '{"minWordSizeForTypos":{"oneTypo":4,"twoTypos":10}}' +updating_guide_check_version_new_authorization_header: |- + meili config set --project PROJECT_NAME \ + --project-url 'http://' \ + --project-api-key API_KEY + + meili info --project PROJECT_NAME +synonyms_guide_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index movies \ + --synonyms '{"great":["fantastic"],"fantastic":["great"]}' +date_guide_index_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili document add --project PROJECT_NAME --index games --file games.json +date_guide_filterable_attributes_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index games \ + --filterable-attributes release_timestamp +date_guide_filter_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index games \ + --q '' \ + --filter 'release_timestamp >= 1514761200 AND release_timestamp < 1672527600' +date_guide_sortable_attributes_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index games \ + --sortable-attributes release_timestamp +date_guide_sort_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index games \ + --q '' --sort release_timestamp:desc +async_guide_filter_by_statuses_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili task list --project PROJECT_NAME --statuses failed +async_guide_filter_by_statuses_2: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili task list --project PROJECT_NAME --statuses failed,canceled +async_guide_multiple_filters_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili task list --project PROJECT_NAME \ + --index-ids movies --types documentAdditionOrUpdate,documentDeletion \ + --statuses processing +faceted_search_update_settings_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index books \ + --filterable-attributes genres,rating,language +faceted_search_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index books \ + --q classic --facets genres,rating,language +filtering_update_settings_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index movie_ratings \ + --filterable-attributes genres,director,release_date,ratings +facet_search_2: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index books \ + --faceting '{"sortFacetValuesBy":{"genres":"count"}}' +facet_search_3: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili facet-search --project PROJECT_NAME --index books \ + --facet-query c --facet-name genres +facet_search_exhaustive_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili facet-search --project PROJECT_NAME --index books \ + --facet-name genres --facet-query c --exhaustive-facet-count +distinct_attribute_guide_filterable_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index products \ + --filterable-attributes product_id,sku,url +distinct_attribute_guide_distinct_parameter_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index products \ + --q 'white shirt' --distinct sku +search_parameter_guide_vector_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index INDEX_NAME \ + --vector 0,1,2 --hybrid '{"embedder":"EMBEDDER_NAME"}' +ai_search_user_embeddings_documents_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili document add --project PROJECT_NAME --index INDEX_NAME \ + --data '[ + { + "id": 0, + "_vectors": { "EMBEDDER_NAME": [0, 0.8, -0.2] }, + "text": "frying pan" + }, + { + "id": 1, + "_vectors": { "EMBEDDER_NAME": [1, -0.2, 0] }, + "text": "baking dish" + } + ]' +ai_search_user_embeddings_search_vector_filter_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index INDEX_NAME \ + --vector 0,1,2 --filter 'price < 10' --sort price:asc \ + --hybrid '{"embedder":"EMBEDDER_NAME"}' +user_provided_embeddings_settings_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index INDEX_NAME \ + --embedders '{ + "EMBEDDER_NAME": { + "source": "userProvided", + "dimensions": MODEL_DIMENSIONS + } + }' +image_search_user_embeddings_search_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index INDEX_NAME \ + --vector VECTORIZED_QUERY --hybrid '{"embedder":"EMBEDDER_NAME"}' +image_search_user_embeddings_search_q_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index INDEX_NAME \ + --vector VECTORIZED_QUERY --hybrid '{"embedder":"EMBEDDER_NAME"}' --q QUERY +federated_search_multi_search_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili multi-search --project PROJECT_NAME \ + --federation '{}' \ + --queries '[ + { "indexUid": "chats", "q": "natasha" }, + { "indexUid": "profiles", "q": "natasha" }, + { "indexUid": "tickets", "q": "natasha" } + ]' +federated_search_multi_search_weight_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili multi-search --project PROJECT_NAME \ + --federation '{}' \ + --queries '[ + { "indexUid": "chats", "q": "rotondo" }, + { + "indexUid": "profiles", + "q": "rotondo", + "federationOptions": { "weight": 1.2 } + }, + { "indexUid": "tickets", "q": "rotondo" } + ]' +search_rules_guide_search_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index support --q 'invoice settings' +update_foreign_keys_setting_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index books \ + --foreign-keys '[ + { "foreignIndexUid": "authors", "fieldName": "author" }, + { + "foreignIndexUid": "authors", + "fieldName": "related_authors" + } + ]' +reset_foreign_keys_setting_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index books --foreign-keys null +chat_create_key_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key MEILISEARCH_KEY + + meili key add --project PROJECT_NAME \ + --name 'Chat API Key' --description 'API key for chat completions' \ + --actions search,chatCompletions --indexes '*' --expires-at null +image_search_multimodal_settings_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index INDEX_NAME \ + --embedders '{ + "MULTIMODAL_EMBEDDER_NAME": { + "source": "rest", + "url": "https://api.voyageai.com/v1/multimodal-embeddings", + "apiKey": "VOYAGE_API_KEY", + "indexingFragments": { + "TEXTUAL_FRAGMENT_NAME": { + "value": { + "content": [ + { + "type": "text", + "text": "A document named {{doc.title}} described as {{doc.description}}" + } + ] + } + }, + "IMAGE_FRAGMENT_NAME": { + "value": { + "content": [ + { + "type": "image_url", + "image_url": "{{doc.poster_url}}" + } + ] + } + } + }, + "searchFragments": { + "USER_TEXT_FRAGMENT": { + "value": { "content": [{ "type": "text", "text": "{{q}}" }] } + }, + "USER_SUBMITTED_IMAGE_FRAGMENT": { + "value": { + "content": [ + { + "type": "image_base64", + "image_base64": "data:{{media.image.mime}};base64,{{media.image.data}}" + } + ] + } + } + }, + "request": { + "inputs": ["{{fragment}}", "{{..}}"], + "model": "voyage-multimodal-3" + }, + "response": { + "data": [{ "embedding": "{{embedding}}" }, "{{..}}"] + } + } + }' +image_search_multimodal_search_text_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index INDEX_NAME \ + --q 'a mountain sunset with snow' \ + --hybrid '{"embedder":"MULTIMODAL_EMBEDDER_NAME"}' +ai_search_getting_started_embedders_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index kitchenware \ + --embedders '{ + "products-openai": { + "source": "openAi", + "apiKey": "OPEN_AI_API_KEY", + "model": "text-embedding-3-small", + "documentTemplate": "An object used in a kitchen named '\''{{doc.name}}'\''" + } + }' +ai_search_getting_started_search_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index kitchenware \ + --q 'kitchen utensils made of wood' \ + --hybrid '{"embedder":"products-openai"}' +configure_rest_embedder_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index INDEX_NAME \ + --embedders '{ + "EMBEDDER_NAME": { + "source": "rest", + "url": "PROVIDER_URL", + "request": { "model": "MODEL_NAME", "input": ["{{text}}", "{{..}}"] }, + "response": { + "data": [{ "embedding": "{{embedding}}" }, "{{..}}"] + }, + "apiKey": "PROVIDER_API_KEY", + "documentTemplate": "SHORT_AND_RELEVANT_DOCUMENT_TEMPLATE" + } + }' +joins_define_relationship_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index deals \ + --data '{ + "foreignKeys": [ + { + "fieldName": "company_id", + "foreignIndexUid": "companies" + } + ], + "filterableAttributes": [ + { + "attributePatterns": ["company_id"], + "features": { + "facetSearch": false, + "filter": { "equality": true, "comparison": false } + } + } + ] + }' +joins_one_to_one_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index users \ + --data '{ + "foreignKeys": [ + { "fieldName": "profile_id", "foreignIndexUid": "profiles" } + ], + "filterableAttributes": [ + { + "attributePatterns": ["profile_id"], + "features": { + "facetSearch": false, + "filter": { "equality": true, "comparison": false } + } + } + ] + }' +joins_one_to_many_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index companies \ + --data '{ + "foreignKeys": [ + { + "fieldName": "employee_ids", + "foreignIndexUid": "employees" + } + ], + "filterableAttributes": [ + { + "attributePatterns": ["employee_ids"], + "features": { + "facetSearch": false, + "filter": { "equality": true, "comparison": false } + } + } + ] + }' +joins_many_to_many_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index films \ + --data '{ + "foreignKeys": [ + { "fieldName": "actor_ids", "foreignIndexUid": "actors" } + ], + "filterableAttributes": [ + { + "attributePatterns": ["actor_ids"], + "features": { + "facetSearch": false, + "filter": { "equality": true, "comparison": false } + } + } + ] + }' +joins_self_reference_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index products \ + --data '{ + "foreignKeys": [ + { + "fieldName": "frequently_bought_with", + "foreignIndexUid": "products" + } + ], + "filterableAttributes": [ + { + "attributePatterns": ["frequently_bought_with"], + "features": { + "facetSearch": false, + "filter": { "equality": true, "comparison": false } + } + } + ] + }' +joins_multiple_relationships_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index deals \ + --data '{ + "foreignKeys": [ + { + "fieldName": "company_id", + "foreignIndexUid": "companies" + }, + { "fieldName": "owner_user_id", "foreignIndexUid": "users" } + ], + "filterableAttributes": [ + { + "attributePatterns": ["company_id"], + "features": { + "facetSearch": false, + "filter": { "equality": true, "comparison": false } + } + }, + { + "attributePatterns": ["owner_user_id"], + "features": { + "facetSearch": false, + "filter": { "equality": true, "comparison": false } + } + } + ] + }' +joins_update_relationship_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index deals \ + --data '{ + "foreignKeys": [ + { + "fieldName": "assigned_user_id", + "foreignIndexUid": "users" + } + ], + "filterableAttributes": [ + { + "attributePatterns": ["assigned_user_id"], + "features": { + "facetSearch": false, + "filter": { "equality": true, "comparison": false } + } + } + ] + }' +joins_remove_relationships_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili settings update --project PROJECT_NAME --index deals --foreign-keys '[]' +foreign_filter_basic_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index deals \ + --q contract \ + --filter '_foreign(company, industry = "Technology" AND founded_year >= 2000)' +foreign_filter_equality_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index deals \ + --q contract --filter '_foreign(company, id = "company_42")' +foreign_filter_multiple_equality_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index deals \ + --q '' \ + --filter '_foreign(company, industry = "Technology" OR industry = "Finance")' +foreign_filter_range_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index deals \ + --q enterprise \ + --filter '_foreign(company, founded_year >= 2000 AND founded_year <= 2020)' +foreign_filter_date_range_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index deals \ + --q '' --filter '_foreign(company, last_funding_date >= "2023-01-01")' +foreign_filter_multiple_conditions_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index deals \ + --q contract \ + --filter '_foreign(company, (industry = "Technology" AND founded_year >= 2010) OR revenue > 1000000)' +foreign_filter_combined_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index deals \ + --q contract \ + --filter 'value >= 100000 AND _foreign(company, industry = "Technology")' +foreign_filter_array_or_logic_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index films \ + --filter 'actors.country = "France" OR actors.age > 35' +foreign_filter_array_and_logic_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index films \ + --filter '_foreign(actors, country = "France" AND age > 35)' +foreign_filter_certifications_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index products \ + --q motor \ + --filter '_foreign(certifications, (standard = "ISO 9001" OR standard = "CE") AND issued_year >= 2020)' +foreign_filter_tags_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index articles \ + --q cryptography \ + --filter '_foreign(tags, name = "security" AND name = "encryption")' +foreign_filter_skills_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index employees \ + --q fullstack \ + --filter '_foreign(skills, (language = "Python" AND proficiency = "advanced") OR (language = "JavaScript" AND proficiency = "advanced"))' +rbac_search_with_foreign_filter_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key TENANT_TOKEN + + meili search --project PROJECT_NAME --index documents \ + --q roadmap \ + --filter '_foreign(access, user = "jeremy@meilisearch.com" OR teams IN ["product", "engineering"])' +rbac_multi_level_1: |- + meili config set --project PROJECT_NAME \ + --project-url MEILISEARCH_URL \ + --project-api-key API_KEY + + meili search --project PROJECT_NAME --index documents \ + --q sensitive \ + --filter '_foreign(access, (user = "jeremy@meilisearch.com" AND roles IN ["editor", "owner"]) OR (teams IN ["product", "engineering"] AND roles IN ["editor"]))' diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index e7d0ae0d..85cec40f 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -29,6 +29,7 @@ - [ ] The ADRs that touch this change were read; what they decide still holds, or a new ADR says what changed - [ ] No accepted ADR was edited. A new ADR was added if a decision changed. - [ ] New or changed prose follows the writing style of rule 17 of `CLAUDE.md` +- [ ] `.code-samples.meilisearch.yaml` updated by rule 19 of `CLAUDE.md`: a new command has a sample for every cURL sample of the documentation it covers, and a renamed or removed command or flag is updated in every sample; or nothing to update ## Housekeeping diff --git a/CLAUDE.md b/CLAUDE.md index b60f73de..013eea76 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -40,6 +40,9 @@ Package: `@meilisearch/cli` on npm. Binary: `meili`. - **An answer.** Ask only with `choose`, `ask` and `askSecret` of `src/lib/terminal.ts`. They send `cli_prompt_answered` and `cli_prompt_aborted`. Give every new question a new, stable `prompt` id, and every option of `choose` a stable `id`. An option that is the user's own data, such as a team, has no `id`: the event then has no `choice`. A renamed id breaks the funnels in PostHog. - **Never a value.** No flag value, free text, name, URL, key or document. Only names and fixed ids. - **A new event or property is a contract change.** It goes in the "Analytics" section of `docs/contract/config.md`, with a new ADR. +19. `.code-samples.meilisearch.yaml` holds the `meili` samples of the Meilisearch documentation. The documentation shows each sample next to the cURL sample of the same key, so keep the keys of the documentation. A sample does what its cURL sample does. It starts with the `meili config set` that adds the project, then runs the command with `--project PROJECT_NAME`. Only a command that the CLI implements has a sample. + - **A new command.** Add a sample for every cURL sample of the documentation that the command covers. The cURL samples are in `.code-samples.meilisearch.yaml` of the `meilisearch/documentation` repository. + - **A renamed or removed command or flag.** Update every sample that uses it, in the same pull request. `test/contract/docs.test.ts` fails when a sample uses a command or a flag that does not exist. ## Stack @@ -74,8 +77,9 @@ Use the skill: `/add-command `, for example `/add-command stats`. If th 6. Create `test/commands/.test.ts` from the sibling test. It must snapshot the `--help` output and the JSON output for one success case and one error case, with `msw` mocks. 7. For a Meilisearch command, add one integration test in `test/integration/meilisearch/`. Meilisearch runs locally from the `docker compose` file of this repository. A management command has no integration test. Meilisearch Cloud does not run locally. Its OpenAPI document is the source of truth, and the unit tests mock the API from that document (`docs/contract/testing.md`). If the document does not describe something, report the gap to the Cloud team. Do not guess. 8. Run `pnpm gen:manifest` so `oclif.manifest.json` and `meili schema` know the command. -9. Add a changeset of type `minor`, by the rules of `.changeset/README.md`. -10. Run the "Before you finish" list. +9. Add the code samples of the command to `.code-samples.meilisearch.yaml` (rule 19). +10. Add a changeset of type `minor`, by the rules of `.changeset/README.md`. +11. Run the "Before you finish" list. ## Changesets diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c22608a3..0f41191b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -68,7 +68,11 @@ pnpm typecheck ## Add a command -Run `/add-command stats` with Claude Code, or follow "How to add a command" in `CLAUDE.md`. In short: one command per pull request. The command name comes from its API routes, by the rules of [`docs/contract/commands.md`](docs/contract/commands.md). The pull request includes a snapshot test, an integration test, the manifest regenerated by `pnpm gen:manifest`, and a changeset. +Run `/add-command stats` with Claude Code, or follow "How to add a command" in `CLAUDE.md`. In short: one command per pull request. The command name comes from its API routes, by the rules of [`docs/contract/commands.md`](docs/contract/commands.md). The pull request includes a snapshot test, an integration test, the manifest regenerated by `pnpm gen:manifest`, the code samples of the command in `.code-samples.meilisearch.yaml`, and a changeset. + +## Code samples + +The Meilisearch documentation shows a CLI tab next to its cURL samples. It reads these samples from `.code-samples.meilisearch.yaml`. When a command or a flag changes, update the samples that use it in the same pull request. See rule 19 of `CLAUDE.md`. ## Release diff --git a/test/contract/docs.test.ts b/test/contract/docs.test.ts index 6664ef34..5549553f 100644 --- a/test/contract/docs.test.ts +++ b/test/contract/docs.test.ts @@ -1,12 +1,15 @@ /** * The paths, scripts, statics and commands that the guides cite exist. A * renamed file or helper that a doc still names fails here, not in a reader's - * hands. Fenced code blocks are not checked, only inline code spans. + * hands. Fenced code blocks are not checked, only inline code spans. The + * code samples of the documentation are checked too: every command and flag + * they run exists. */ import { existsSync, readFileSync } from "node:fs"; import { glob } from "node:fs/promises"; import { join } from "node:path"; import { describe, expect, it } from "vitest"; +import { parse } from "yaml"; import { BaseCommand } from "../../src/lib/base-command.js"; import { PROJECT_ROOT } from "../helpers/run-command.js"; import { codeSpans, readDoc } from "./markdown.js"; @@ -24,7 +27,7 @@ const PLANNED_PATHS: string[] = []; /** A span that is a path of this repository: a known top-level file or folder. */ const PATH_SPAN = - /^(?:src|test|docs|scripts|bin|\.claude|\.github|\.changeset)\/[\w./@-]*$|^(?:CLAUDE|README|CONTRIBUTING|CHANGELOG)\.md$|^(?:package\.json|oclif\.manifest\.json|docker-compose\.yml)$/; + /^(?:src|test|docs|scripts|bin|\.claude|\.github|\.changeset)\/[\w./@-]*$|^(?:CLAUDE|README|CONTRIBUTING|CHANGELOG)\.md$|^(?:package\.json|oclif\.manifest\.json|docker-compose\.yml|\.code-samples\.meilisearch\.yaml)$/; const PNPM_BUILTINS = new Set(["install", "link", "exec", "add", "remove", "dlx"]); const scripts = Object.keys( @@ -34,13 +37,17 @@ const scripts = Object.keys( } ).scripts, ); -const manifestIds = Object.keys( - ( - JSON.parse(readFileSync(join(PROJECT_ROOT, "oclif.manifest.json"), "utf8")) as { - commands: Record; - } - ).commands, -).map((id) => id.replaceAll(":", " ")); +/** The commands of the manifest, by their id with spaces, with the flags they accept. */ +const manifest = new Map( + Object.entries( + ( + JSON.parse(readFileSync(join(PROJECT_ROOT, "oclif.manifest.json"), "utf8")) as { + commands: Record }>; + } + ).commands, + ).map(([id, command]) => [id.replaceAll(":", " "), Object.keys(command.flags)]), +); +const manifestIds = [...manifest.keys()]; describe("the guides cite things that exist", () => { for (const guide of guides) { @@ -88,3 +95,28 @@ describe("the guides cite things that exist", () => { } }); }); + +describe("the code samples run commands and flags that exist (CLAUDE.md, rule 19)", () => { + const samples = parse(readDoc(".code-samples.meilisearch.yaml")) as Record; + + for (const [key, sample] of Object.entries(samples)) { + it(key, () => { + // One command per line: join the continued lines, then drop the quoted values. + const lines = sample + .replaceAll("\\\n", " ") + .replace(/'(?:[^']|'\\'')*'/g, "''") + .split("\n") + .filter((line) => line.startsWith("meili ")); + expect(lines.length, "the sample runs no command").toBeGreaterThan(0); + for (const line of lines) { + const [first = "", second = ""] = line.split(/\s+/).slice(1); + const id = [`${first} ${second}`, first].find((candidate) => manifest.has(candidate)); + expect(id, `\`${line}\` runs no command`).toBeDefined(); + const flags = manifest.get(id as string) ?? []; + for (const [, flag] of line.matchAll(/ --([a-z][\w-]*)/g)) { + expect(flags, `\`meili ${id}\` has no flag --${flag}`).toContain(flag); + } + } + }); + } +}); From 3e6da3cddd3853c4d198efc2794840c8fbecd027 Mon Sep 17 00:00:00 2001 From: curquiza Date: Mon, 9 Nov 2026 18:49:59 +0100 Subject: [PATCH 2/2] Put meili config set on one line in the code samples --- .code-samples.meilisearch.yaml | 712 +++++++++------------------------ 1 file changed, 178 insertions(+), 534 deletions(-) diff --git a/.code-samples.meilisearch.yaml b/.code-samples.meilisearch.yaml index b6a8793a..14c5dfb8 100644 --- a/.code-samples.meilisearch.yaml +++ b/.code-samples.meilisearch.yaml @@ -4,53 +4,37 @@ # Only the commands that the CLI implements have a sample. See CLAUDE.md, rule 19. --- get_one_index_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili index view --project PROJECT_NAME --id movies list_all_indexes_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili index list --project PROJECT_NAME --limit 3 create_an_index_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili index add --project PROJECT_NAME --id movies --primary-key id update_an_index_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili index update --project PROJECT_NAME --id movies --primary-key id delete_an_index_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili index delete --project PROJECT_NAME --id movies --yes get_one_document_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili document view --project PROJECT_NAME --index movies --id 25684 \ --fields id,title,poster,release_date get_documents_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili document list --project PROJECT_NAME --index movies \ --limit 2 --filter genres=action add_or_replace_documents_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili document add --project PROJECT_NAME --index movies \ --data '[ @@ -63,112 +47,78 @@ add_or_replace_documents_1: |- } ]' add_or_update_documents_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili document update --project PROJECT_NAME --index movies \ --data '[{"id":287947,"title":"Shazam ⚡️","genres":"comedy"}]' delete_all_documents_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili document delete --project PROJECT_NAME --index movies --all --yes delete_one_document_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili document delete --project PROJECT_NAME --index movies --ids 25684 --yes delete_documents_by_batch_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili document delete --project PROJECT_NAME --index movies \ --ids 23488,153738,437035,363869 --yes search_post_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index movies --q 'american ninja' search_get_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index movies --q 'american ninja' get_all_tasks_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili task list --project PROJECT_NAME get_task_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili task view --project PROJECT_NAME --id 1 get_all_tasks_paginating_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili task list --project PROJECT_NAME --limit 2 --from 10 get_all_tasks_paginating_2: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili task list --project PROJECT_NAME --limit 2 --from 8 get_one_key_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key MASTER_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key MASTER_KEY meili key view --project PROJECT_NAME --id 6062abda-a5aa-4414-ac91-ecd7944c0f8d get_all_keys_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key MASTER_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key MASTER_KEY meili key list --project PROJECT_NAME --limit 3 create_a_key_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key MASTER_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key MASTER_KEY meili key add --project PROJECT_NAME \ --description 'Add documents: Products API key' --actions documents.add \ --indexes products --expires-at 2042-04-02T00:42:42Z update_a_key_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key MASTER_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key MASTER_KEY meili key update --project PROJECT_NAME --id 6062abda-a5aa-4414-ac91-ecd7944c0f8d \ --name 'Products/Reviews API key' \ --description 'Manage documents: Products/Reviews API key' delete_a_key_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key MASTER_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key MASTER_KEY meili key delete --project PROJECT_NAME --id 6062abda-a5aa-4414-ac91-ecd7944c0f8d \ --yes get_settings_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings view --project PROJECT_NAME --index movies update_settings_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index movies \ --ranking-rules words,typo,proximity,attributeRank,sort,wordPosition,exactness,release_date:desc,rank:desc \ @@ -183,15 +133,11 @@ update_settings_1: |- --pagination '{"maxTotalHits":5000}' --faceting '{"maxValuesPerFacet":200}' \ --search-cutoff-ms 150 reset_settings_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings delete --project PROJECT_NAME --index movies --yes update_synonyms_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index movies \ --synonyms '{ @@ -200,55 +146,39 @@ update_synonyms_1: |- "wow": ["world of warcraft"] }' reset_synonyms_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index movies --synonyms null update_stop_words_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index movies \ --stop-words the,of,to reset_stop_words_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index movies --stop-words null update_ranking_rules_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index movies \ --ranking-rules words,typo,proximity,attributeRank,sort,wordPosition,exactness,release_date:asc,rank:desc reset_ranking_rules_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index movies --ranking-rules null update_distinct_attribute_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index shoes \ --distinct-attribute skuid reset_distinct_attribute_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index shoes \ --distinct-attribute null update_filterable_attributes_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index movies \ --data '{ @@ -265,58 +195,42 @@ update_filterable_attributes_1: |- ] }' reset_filterable_attributes_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index movies \ --filterable-attributes null update_searchable_attributes_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index movies \ --searchable-attributes title,overview,genres reset_searchable_attributes_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index movies \ --searchable-attributes null update_displayed_attributes_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index movies \ --displayed-attributes title,overview,genres,release_date reset_displayed_attributes_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index movies \ --displayed-attributes null update_sortable_attributes_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index books \ --sortable-attributes price,author reset_sortable_attributes_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index books \ --sortable-attributes null update_typo_tolerance_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index books \ --typo-tolerance '{ @@ -324,28 +238,20 @@ update_typo_tolerance_1: |- "disableOnAttributes": ["title"] }' reset_typo_tolerance_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index books --typo-tolerance null update_pagination_settings_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index books \ --pagination '{"maxTotalHits":100}' reset_pagination_settings_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index books --pagination null update_faceting_settings_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index books \ --faceting '{ @@ -357,126 +263,90 @@ update_faceting_settings_1: |- } }' update_faceting_settings_max_values_per_facet_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index books \ --faceting '{"maxValuesPerFacet":20}' reset_faceting_settings_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index books --faceting null update_separator_tokens_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index articles \ --separator-tokens '|,…' reset_separator_tokens_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index articles \ --separator-tokens null update_non_separator_tokens_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index articles \ --non-separator-tokens '@,#' reset_non_separator_tokens_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index articles \ --non-separator-tokens null update_dictionary_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index books \ --dictionary 'J. R. R.,W. E. B.' reset_dictionary_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index books --dictionary null update_proximity_precision_settings_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index books \ --proximity-precision byAttribute reset_proximity_precision_settings_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index books \ --proximity-precision null update_facet_search_settings_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index INDEX_UID \ --facet-search false reset_facet_search_settings_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index INDEX_UID \ --facet-search null update_prefix_search_settings_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index INDEX_UID \ --prefix-search disabled reset_prefix_search_settings_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index INDEX_UID \ --prefix-search null update_search_cutoff_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index movies \ --search-cutoff-ms 150 reset_search_cutoff_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index movies \ --search-cutoff-ms null update_localized_attribute_settings_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index INDEX_NAME \ --localized-attributes '[{"locales":["jpn"],"attributePatterns":["*_ja"]}]' multilingual_dataset_guide_update_localized_attributes_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index INDEX_NAME \ --localized-attributes '[ @@ -485,16 +355,12 @@ multilingual_dataset_guide_update_localized_attributes_1: |- { "attributePatterns": ["*_fr"], "locales": ["fra"] } ]' reset_localized_attribute_settings_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index INDEX_NAME \ --localized-attributes null update_embedders_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index INDEX_NAME \ --embedders '{ @@ -506,9 +372,7 @@ update_embedders_1: |- } }' update_embedders_distribution_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key MEILISEARCH_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key MEILISEARCH_KEY meili settings update --project PROJECT_NAME --index INDEX_NAME \ --embedders '{ @@ -519,15 +383,11 @@ update_embedders_distribution_1: |- } }' reset_embedders_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index INDEX_NAME --embedders null update_chat_settings_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index INDEX_NAME \ --chat '{ @@ -536,27 +396,19 @@ update_chat_settings_1: |- "documentTemplateMaxBytes": 400 }' reset_chat_settings_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index INDEX_NAME --chat null delete_tasks_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili task delete --project PROJECT_NAME --ids 1,2 --yes cancel_tasks_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili task cancel --project PROJECT_NAME --ids 1,2 multi_search_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili multi-search --project PROJECT_NAME \ --queries '[ @@ -565,280 +417,198 @@ multi_search_1: |- { "indexUid": "movie_ratings", "q": "us" } ]' get_documents_post_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili document list --project PROJECT_NAME --index books \ --filter '(rating > 3 AND (genres = Adventure OR genres = Fiction)) AND language = English' \ --fields title,genres,rating,language --limit 3 get_documents_post_with_filter_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili document list --project PROJECT_NAME --index movies \ --filter 'genres = Action AND rating > 8' delete_documents_by_filter_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili document delete --project PROJECT_NAME --index movies \ --filter 'genres = action OR genres = adventure' --yes facet_search_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili facet-search --project PROJECT_NAME --index books \ --facet-query fiction --facet-name genres --filter 'rating > 3' get_all_batches_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili batch list --project PROJECT_NAME get_batch_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili batch view --project PROJECT_NAME --id 0 get_similar_post_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key DEFAULT_SEARCH_API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key DEFAULT_SEARCH_API_KEY meili similar --project PROJECT_NAME --index INDEX_NAME \ --id TARGET_DOCUMENT_ID --embedder EMBEDDER_NAME get_similar_get_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili similar --project PROJECT_NAME --index INDEX_NAME \ --id TARGET_DOCUMENT_ID --embedder EMBEDDER_NAME export_post_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili export --project PROJECT_NAME \ --url TARGET_INSTANCE_URL --indexes '{"*":{"overrideSettings":true}}' get_index_stats_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili stats --project PROJECT_NAME --index movies get_indexes_stats_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili stats --project PROJECT_NAME get_health_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili health --project PROJECT_NAME get_version_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili info --project PROJECT_NAME distinct_attribute_guide_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index jackets \ --distinct-attribute product_id field_properties_guide_displayed_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index movies \ --displayed-attributes title,overview,genres,release_date filtering_guide_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index movie_ratings \ --q Avengers --filter 'release_date > 795484800' filtering_guide_2: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index movie_ratings \ --q Batman \ --filter 'release_date > 795484800 AND (director = "Tim Burton" OR director = "Christopher Nolan")' filtering_guide_3: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index movie_ratings \ --q 'Planet of the Apes' \ --filter 'release_date > 1577884550 AND (NOT director = "Tim Burton")' filtering_guide_nested_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index movie_ratings \ --q thriller --filter 'rating.users >= 90' add_movies_json_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili document add --project PROJECT_NAME --index movies --file movies.json getting_started_add_documents: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key aSampleMasterKey + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key aSampleMasterKey meili document add --project PROJECT_NAME --index movies \ --primary-key id --file movies.json getting_started_check_task_status: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key aSampleMasterKey + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key aSampleMasterKey meili task view --project PROJECT_NAME --id 0 getting_started_search: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key aSampleMasterKey + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key aSampleMasterKey meili search --project PROJECT_NAME --index movies --q botman authorization_header_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key MASTER_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key MASTER_KEY meili key list --project PROJECT_NAME sorting_guide_update_sortable_attributes_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index books \ --sortable-attributes author,price sorting_guide_update_ranking_rules_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index books \ --ranking-rules words,sort,typo,proximity,attributeRank,wordPosition,exactness sorting_guide_sort_nested_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index books \ --q 'science fiction' --sort rating.users:asc sorting_guide_sort_parameter_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index books \ --q 'science fiction' --sort price:asc sorting_guide_sort_parameter_2: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index books --q butler --sort author:desc geosearch_guide_filter_settings_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index restaurants \ --filterable-attributes _geo geosearch_guide_filter_settings_2: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index neighborhoods \ --filterable-attributes _geojson geosearch_guide_filter_usage_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index restaurants \ --filter '_geoRadius(45.472735, 9.184019, 2000)' geosearch_guide_filter_usage_2: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index restaurants \ --filter '_geoRadius(45.472735, 9.184019, 2000) AND type = pizza' geosearch_guide_filter_usage_3: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index restaurants \ --filter '_geoBoundingBox([45.494181, 9.214024], [45.449484, 9.179175])' geosearch_guide_sort_settings_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index restaurants \ --sortable-attributes _geo geosearch_guide_sort_usage_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index restaurants \ --data '{"sort":["_geoPoint(48.8561446,2.2978204):asc"]}' geosearch_guide_sort_usage_2: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index restaurants \ --data '{ "sort": ["_geoPoint(48.8561446,2.2978204):asc", "rating:desc"] }' basic_security_tutorial_admin_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key DEFAULT_ADMIN_API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key DEFAULT_ADMIN_API_KEY meili index add --project PROJECT_NAME --id medical_records --primary-key id basic_security_tutorial_search_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key DEFAULT_SEARCH_API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key DEFAULT_SEARCH_API_KEY meili search --project PROJECT_NAME --index medical_records --q appointments primary_field_guide_create_index_primary_key: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili index add --project PROJECT_NAME --id books --primary-key reference_number primary_field_guide_add_document_primary_key: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili document add --project PROJECT_NAME --index books \ --primary-key reference_number \ @@ -852,180 +622,128 @@ primary_field_guide_add_document_primary_key: |- } ]' primary_field_guide_update_document_primary_key: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili index update --project PROJECT_NAME --id books --primary-key title tenant_token_guide_search_no_sdk_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key TENANT_TOKEN + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key TENANT_TOKEN meili search --project PROJECT_NAME --index patient_medical_records typo_tolerance_guide_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index movies \ --typo-tolerance '{"enabled":false}' typo_tolerance_guide_2: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index movies \ --typo-tolerance '{"disableOnAttributes":["title"]}' typo_tolerance_guide_3: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index movies \ --typo-tolerance '{"disableOnWords":["shrek"]}' typo_tolerance_guide_4: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index movies \ --typo-tolerance '{"minWordSizeForTypos":{"oneTypo":4,"twoTypos":10}}' updating_guide_check_version_new_authorization_header: |- - meili config set --project PROJECT_NAME \ - --project-url 'http://' \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url 'http://' --project-api-key API_KEY meili info --project PROJECT_NAME synonyms_guide_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index movies \ --synonyms '{"great":["fantastic"],"fantastic":["great"]}' date_guide_index_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili document add --project PROJECT_NAME --index games --file games.json date_guide_filterable_attributes_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index games \ --filterable-attributes release_timestamp date_guide_filter_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index games \ --q '' \ --filter 'release_timestamp >= 1514761200 AND release_timestamp < 1672527600' date_guide_sortable_attributes_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index games \ --sortable-attributes release_timestamp date_guide_sort_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index games \ --q '' --sort release_timestamp:desc async_guide_filter_by_statuses_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili task list --project PROJECT_NAME --statuses failed async_guide_filter_by_statuses_2: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili task list --project PROJECT_NAME --statuses failed,canceled async_guide_multiple_filters_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili task list --project PROJECT_NAME \ --index-ids movies --types documentAdditionOrUpdate,documentDeletion \ --statuses processing faceted_search_update_settings_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index books \ --filterable-attributes genres,rating,language faceted_search_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index books \ --q classic --facets genres,rating,language filtering_update_settings_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index movie_ratings \ --filterable-attributes genres,director,release_date,ratings facet_search_2: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index books \ --faceting '{"sortFacetValuesBy":{"genres":"count"}}' facet_search_3: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili facet-search --project PROJECT_NAME --index books \ --facet-query c --facet-name genres facet_search_exhaustive_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili facet-search --project PROJECT_NAME --index books \ --facet-name genres --facet-query c --exhaustive-facet-count distinct_attribute_guide_filterable_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index products \ --filterable-attributes product_id,sku,url distinct_attribute_guide_distinct_parameter_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index products \ --q 'white shirt' --distinct sku search_parameter_guide_vector_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index INDEX_NAME \ --vector 0,1,2 --hybrid '{"embedder":"EMBEDDER_NAME"}' ai_search_user_embeddings_documents_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili document add --project PROJECT_NAME --index INDEX_NAME \ --data '[ @@ -1041,17 +759,13 @@ ai_search_user_embeddings_documents_1: |- } ]' ai_search_user_embeddings_search_vector_filter_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index INDEX_NAME \ --vector 0,1,2 --filter 'price < 10' --sort price:asc \ --hybrid '{"embedder":"EMBEDDER_NAME"}' user_provided_embeddings_settings_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index INDEX_NAME \ --embedders '{ @@ -1061,23 +775,17 @@ user_provided_embeddings_settings_1: |- } }' image_search_user_embeddings_search_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index INDEX_NAME \ --vector VECTORIZED_QUERY --hybrid '{"embedder":"EMBEDDER_NAME"}' image_search_user_embeddings_search_q_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index INDEX_NAME \ --vector VECTORIZED_QUERY --hybrid '{"embedder":"EMBEDDER_NAME"}' --q QUERY federated_search_multi_search_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili multi-search --project PROJECT_NAME \ --federation '{}' \ @@ -1087,9 +795,7 @@ federated_search_multi_search_1: |- { "indexUid": "tickets", "q": "natasha" } ]' federated_search_multi_search_weight_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili multi-search --project PROJECT_NAME \ --federation '{}' \ @@ -1103,15 +809,11 @@ federated_search_multi_search_weight_1: |- { "indexUid": "tickets", "q": "rotondo" } ]' search_rules_guide_search_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index support --q 'invoice settings' update_foreign_keys_setting_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index books \ --foreign-keys '[ @@ -1122,23 +824,17 @@ update_foreign_keys_setting_1: |- } ]' reset_foreign_keys_setting_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index books --foreign-keys null chat_create_key_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key MEILISEARCH_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key MEILISEARCH_KEY meili key add --project PROJECT_NAME \ --name 'Chat API Key' --description 'API key for chat completions' \ --actions search,chatCompletions --indexes '*' --expires-at null image_search_multimodal_settings_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index INDEX_NAME \ --embedders '{ @@ -1193,17 +889,13 @@ image_search_multimodal_settings_1: |- } }' image_search_multimodal_search_text_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index INDEX_NAME \ --q 'a mountain sunset with snow' \ --hybrid '{"embedder":"MULTIMODAL_EMBEDDER_NAME"}' ai_search_getting_started_embedders_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index kitchenware \ --embedders '{ @@ -1215,17 +907,13 @@ ai_search_getting_started_embedders_1: |- } }' ai_search_getting_started_search_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index kitchenware \ --q 'kitchen utensils made of wood' \ --hybrid '{"embedder":"products-openai"}' configure_rest_embedder_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index INDEX_NAME \ --embedders '{ @@ -1241,9 +929,7 @@ configure_rest_embedder_1: |- } }' joins_define_relationship_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index deals \ --data '{ @@ -1264,9 +950,7 @@ joins_define_relationship_1: |- ] }' joins_one_to_one_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index users \ --data '{ @@ -1284,9 +968,7 @@ joins_one_to_one_1: |- ] }' joins_one_to_many_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index companies \ --data '{ @@ -1307,9 +989,7 @@ joins_one_to_many_1: |- ] }' joins_many_to_many_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index films \ --data '{ @@ -1327,9 +1007,7 @@ joins_many_to_many_1: |- ] }' joins_self_reference_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index products \ --data '{ @@ -1350,9 +1028,7 @@ joins_self_reference_1: |- ] }' joins_multiple_relationships_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index deals \ --data '{ @@ -1381,9 +1057,7 @@ joins_multiple_relationships_1: |- ] }' joins_update_relationship_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index deals \ --data '{ @@ -1404,115 +1078,85 @@ joins_update_relationship_1: |- ] }' joins_remove_relationships_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili settings update --project PROJECT_NAME --index deals --foreign-keys '[]' foreign_filter_basic_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index deals \ --q contract \ --filter '_foreign(company, industry = "Technology" AND founded_year >= 2000)' foreign_filter_equality_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index deals \ --q contract --filter '_foreign(company, id = "company_42")' foreign_filter_multiple_equality_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index deals \ --q '' \ --filter '_foreign(company, industry = "Technology" OR industry = "Finance")' foreign_filter_range_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index deals \ --q enterprise \ --filter '_foreign(company, founded_year >= 2000 AND founded_year <= 2020)' foreign_filter_date_range_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index deals \ --q '' --filter '_foreign(company, last_funding_date >= "2023-01-01")' foreign_filter_multiple_conditions_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index deals \ --q contract \ --filter '_foreign(company, (industry = "Technology" AND founded_year >= 2010) OR revenue > 1000000)' foreign_filter_combined_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index deals \ --q contract \ --filter 'value >= 100000 AND _foreign(company, industry = "Technology")' foreign_filter_array_or_logic_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index films \ --filter 'actors.country = "France" OR actors.age > 35' foreign_filter_array_and_logic_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index films \ --filter '_foreign(actors, country = "France" AND age > 35)' foreign_filter_certifications_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index products \ --q motor \ --filter '_foreign(certifications, (standard = "ISO 9001" OR standard = "CE") AND issued_year >= 2020)' foreign_filter_tags_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index articles \ --q cryptography \ --filter '_foreign(tags, name = "security" AND name = "encryption")' foreign_filter_skills_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index employees \ --q fullstack \ --filter '_foreign(skills, (language = "Python" AND proficiency = "advanced") OR (language = "JavaScript" AND proficiency = "advanced"))' rbac_search_with_foreign_filter_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key TENANT_TOKEN + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key TENANT_TOKEN meili search --project PROJECT_NAME --index documents \ --q roadmap \ --filter '_foreign(access, user = "jeremy@meilisearch.com" OR teams IN ["product", "engineering"])' rbac_multi_level_1: |- - meili config set --project PROJECT_NAME \ - --project-url MEILISEARCH_URL \ - --project-api-key API_KEY + meili config set --project PROJECT_NAME --project-url MEILISEARCH_URL --project-api-key API_KEY meili search --project PROJECT_NAME --index documents \ --q sensitive \