diff --git a/.claude/skills/add-command/SKILL.md b/.claude/skills/add-command/SKILL.md index fcd1441..05bb6bf 100644 --- a/.claude/skills/add-command/SKILL.md +++ b/.claude/skills/add-command/SKILL.md @@ -101,7 +101,7 @@ A Management API command has none: Meilisearch Cloud does not run locally (`docs ## 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. +- 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 command name, then `--project-url` and `--project-api-key` on one line, then the other flags. 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 diff --git a/.code-samples.meilisearch.yaml b/.code-samples.meilisearch.yaml index 3bc5c5e..07ba418 100644 --- a/.code-samples.meilisearch.yaml +++ b/.code-samples.meilisearch.yaml @@ -4,47 +4,39 @@ # 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 + meili index view \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 + meili index list \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 + meili index add \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 + meili index update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 + meili index delete \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili document view \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili document list \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili document add \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --index movies \ --data '[ { "id": 287947, @@ -55,97 +47,79 @@ 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 document update --project PROJECT_NAME --index movies \ + meili document update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 + meili document delete \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 + meili document delete \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili document delete \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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' + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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' + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --index movies --q 'american ninja' get_all_tasks_1: |- - meili config set --project PROJECT_NAME \ + meili task list \ --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 + meili task view \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 + meili task list \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 + meili task list \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 + meili key view \ + --project-url MEILISEARCH_URL --project-api-key MASTER_KEY \ + --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 + meili key list \ + --project-url MEILISEARCH_URL --project-api-key MASTER_KEY \ + --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 \ + meili key add \ + --project-url MEILISEARCH_URL --project-api-key MASTER_KEY \ + \ --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 \ + meili key update \ + --project-url MEILISEARCH_URL --project-api-key MASTER_KEY \ + --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 \ + meili key delete \ + --project-url MEILISEARCH_URL --project-api-key MASTER_KEY \ + --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 + meili settings view \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ @@ -158,64 +132,54 @@ 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 settings delete --project PROJECT_NAME --index movies --yes + meili settings delete \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --index movies \ --data '{ "filterableAttributes": [ "genres", @@ -230,77 +194,65 @@ update_filterable_attributes_1: |- ] }' 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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --index books \ --faceting '{ "maxValuesPerFacet": 2, "sortFacetValuesBy": { @@ -310,126 +262,106 @@ 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 settings update --project PROJECT_NAME --index books \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --index INDEX_NAME \ --embedders '{ "default": { "source": "openAi", @@ -439,10 +371,9 @@ update_embedders_1: |- } }' 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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key MEILISEARCH_KEY \ + --index INDEX_NAME \ --embedders '{ "default": { "source": "openAi", @@ -451,281 +382,229 @@ update_embedders_distribution_1: |- } }' 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 + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 + meili task delete \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 + meili task cancel \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili multi-search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + \ --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 \ + meili document list \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili document list \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili document delete \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili facet-search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --index books \ --facet-query fiction --facet-name genres --filter 'rating > 3' get_all_batches_1: |- - meili config set --project PROJECT_NAME \ + meili batch list \ --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 + meili batch view \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili similar \ + --project-url MEILISEARCH_URL --project-api-key DEFAULT_SEARCH_API_KEY \ + --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 \ + meili similar \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili export \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + \ --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 + meili stats \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --index movies get_indexes_stats_1: |- - meili config set --project PROJECT_NAME \ + meili stats \ --project-url MEILISEARCH_URL --project-api-key API_KEY - - meili stats --project PROJECT_NAME get_health_1: |- - meili config set --project PROJECT_NAME \ + meili health \ --project-url MEILISEARCH_URL --project-api-key API_KEY - - meili health --project PROJECT_NAME get_version_1: |- - meili config set --project PROJECT_NAME \ + meili info \ --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 + meili document add \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili document add \ + --project-url MEILISEARCH_URL --project-api-key aSampleMasterKey \ + --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 + meili task view \ + --project-url MEILISEARCH_URL --project-api-key aSampleMasterKey \ + --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 + meili search \ + --project-url MEILISEARCH_URL --project-api-key aSampleMasterKey \ + --index movies --q botman authorization_header_1: |- - meili config set --project PROJECT_NAME \ + meili key list \ --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 + meili index add \ + --project-url MEILISEARCH_URL --project-api-key DEFAULT_ADMIN_API_KEY \ + --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 + meili search \ + --project-url MEILISEARCH_URL --project-api-key DEFAULT_SEARCH_API_KEY \ + --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 + meili index add \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili document add \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --index books \ --primary-key reference_number \ --data '[ { @@ -737,156 +616,129 @@ 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 index update --project PROJECT_NAME --id books --primary-key title + meili index update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 + meili search \ + --project-url MEILISEARCH_URL --project-api-key TENANT_TOKEN \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --index movies \ --typo-tolerance '{"minWordSizeForTypos":{"oneTypo":4,"twoTypos":10}}' updating_guide_check_version_new_authorization_header: |- - meili config set --project PROJECT_NAME \ + meili info \ --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 + meili document add \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 + meili task list \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 + meili task list \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili task list \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + \ --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili facet-search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili facet-search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili document add \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --index INDEX_NAME \ --data '[ { "id": 0, @@ -900,17 +752,15 @@ 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 search --project PROJECT_NAME --index INDEX_NAME \ + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --index INDEX_NAME \ --embedders '{ "EMBEDDER_NAME": { "source": "userProvided", @@ -918,22 +768,19 @@ 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 search --project PROJECT_NAME --index INDEX_NAME \ + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili multi-search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + \ --federation '{}' \ --queries '[ { "indexUid": "chats", "q": "natasha" }, @@ -941,10 +788,9 @@ 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 multi-search --project PROJECT_NAME \ + meili multi-search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + \ --federation '{}' \ --queries '[ { "indexUid": "chats", "q": "rotondo" }, @@ -956,15 +802,13 @@ 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 search --project PROJECT_NAME --index support --q 'invoice settings' + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --index books \ --foreign-keys '[ { "foreignIndexUid": "authors", "fieldName": "author" }, { @@ -973,22 +817,19 @@ 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 settings update --project PROJECT_NAME --index books --foreign-keys null + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili key add \ + --project-url MEILISEARCH_URL --project-api-key MEILISEARCH_KEY \ + \ --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --index INDEX_NAME \ --embedders '{ "MULTIMODAL_EMBEDDER_NAME": { "source": "rest", @@ -1041,17 +882,15 @@ 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 search --project PROJECT_NAME --index INDEX_NAME \ + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --index kitchenware \ --embedders '{ "products-openai": { "source": "openAi", @@ -1061,17 +900,15 @@ 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 search --project PROJECT_NAME --index kitchenware \ + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --index INDEX_NAME \ --embedders '{ "EMBEDDER_NAME": { "source": "rest", @@ -1085,10 +922,9 @@ configure_rest_embedder_1: |- } }' 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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --index deals \ --data '{ "foreignKeys": [ { @@ -1107,10 +943,9 @@ 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 settings update --project PROJECT_NAME --index users \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --index users \ --data '{ "foreignKeys": [ { "fieldName": "profile_id", "foreignIndexUid": "profiles" } @@ -1126,10 +961,9 @@ 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 settings update --project PROJECT_NAME --index companies \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --index companies \ --data '{ "foreignKeys": [ { @@ -1148,10 +982,9 @@ 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 settings update --project PROJECT_NAME --index films \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --index films \ --data '{ "foreignKeys": [ { "fieldName": "actor_ids", "foreignIndexUid": "actors" } @@ -1167,10 +1000,9 @@ 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 settings update --project PROJECT_NAME --index products \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --index products \ --data '{ "foreignKeys": [ { @@ -1189,10 +1021,9 @@ joins_self_reference_1: |- ] }' 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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --index deals \ --data '{ "foreignKeys": [ { @@ -1219,10 +1050,9 @@ joins_multiple_relationships_1: |- ] }' 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 \ + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --index deals \ --data '{ "foreignKeys": [ { @@ -1241,101 +1071,86 @@ joins_update_relationship_1: |- ] }' 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 '[]' + meili settings update \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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 \ + meili search \ + --project-url MEILISEARCH_URL --project-api-key TENANT_TOKEN \ + --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 \ + meili search \ + --project-url MEILISEARCH_URL --project-api-key API_KEY \ + --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/CLAUDE.md b/CLAUDE.md index 013eea7..4be9de4 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -40,7 +40,7 @@ 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. +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 runs the command with `--project-url` and `--project-api-key`, on one line after the command 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.