Skip to main content

Command Line Interface

Below are the available commands for the Search Ultimate module.

Running Reindex from console​

Console reindexing can be performed for the entire store (without mode options), a specific index (see Managing Indexes), or a chosen store.

bin/magento mirasvit:search:reindex 

Possible options are:

OptionDescription
--index=catalogsearch_fulltextallows reindexing of a specific index. For example, to reindex only the Catalog Search index, use catalogsearch_fulltext.
--store=2allows reindexing of all indices for the store with ID 2.

You can get the possible index codes directly in the console by executing the following command:

bin/magento mirasvit:search:reindex --index=default
tip

Command options can be combined:

bin/magento mirasvit:search:reindex --index=catalogsearch_fullindex --store=2

Managing Stopwords from console​

Console stopword management allows you to import and remove stopwords. To remove stopwords, use the following command:

bin/magento mirasvit:search:stopword

Possible options are:

OptionDescription
--file=stopwords.csvdefines, which CSV file will be used for stopwords importing. Format of CSV file, which is used for managing stopwords, can be seen here.!!!!!!!!
--removethe command to remove stopwords instead of importing them. This requires the previous option.
--store=2required argument that forces the import/remove action to be performed only on a specific store (e.g., store ID=2).

Managing Synonyms from console​

Console synonym management allows you to import and remove synonyms. To remove synonyms, use the following command:

bin/magento mirasvit:search:synonym

Possible options are:

OptionDescription
--file=synonyms.csvdefines, which CSV file will be used for synonyms importing. Format of CSV file, which is used for managing synonyms, can be seen here.!!!!!!!!
--removethe command to remove synonyms instead of importing them. This requires the previous option.
--store=2required argument that forces the import/remove action to be performed only on a specific store (e.g., store ID=2).

Managing Search Sphinx from console​

bin/magento mirasvit:search-sphinx:manage

Console management of Search Sphinx includes the following commands:

OptionDescription
--startstarts the Search Daemon.
--stopstops the Search Daemon.
--restartkills the Search Daemon process and starts it with clean data.
--resetclears temporary search data.
--statusdisplays current status of Search Sphinx engine.
--ensurespecial command that automatically checks the status and starts the daemon only if it is not running.