PHPackages code711/solrtools - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [CLI & Console](/categories/cli) 4. / 5. code711/solrtools ActiveTypo3-cms-extension[CLI & Console](/categories/cli) code711/solrtools ================= A set of CLI tools to manage Solr indexes for multi site setups 3.0.5(2mo ago)18.5k↓36.1%[1 issues](https://github.com/codeseveneleven/typo3-solrtools/issues)MITPHPPHP ^8.2CI failing Since Feb 21Pushed 2mo ago1 watchersCompare [ Source](https://github.com/codeseveneleven/typo3-solrtools)[ Packagist](https://packagist.org/packages/code711/solrtools)[ Docs](https://github.com/codeseveneleven/typo3-solrtools)[ RSS](/packages/code711-solrtools/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (10)Dependencies (25)Versions (24)Used By (0) TYPO3 Solr tools ================ [](#typo3-solr-tools) [![Latest Stable Version](https://camo.githubusercontent.com/938172255427e0db93809cd319936aa8ebe79f728a66a47697eb9428bbb275d0/68747470733a2f2f706f7365722e707567782e6f72672f636f64653731312f736f6c72746f6f6c732f762f737461626c652e737667)](https://extensions.typo3.org/extension/solr_tools)[![TYPO3 11](https://camo.githubusercontent.com/5432de37ab8517e6d9e6f803a2e1a7674a308c6d93896fe8a6fbc8a4cb50aece/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5459504f332d31312d6f72616e67652e737667)](https://get.typo3.org/version/11)[![TYPO3 12](https://camo.githubusercontent.com/08afacc49187e63c796f7d1c4401d0f0563bab574d9c525312b2827acb09a7c5/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5459504f332d31322d6f72616e67652e737667)](https://get.typo3.org/version/12)[![Total Downloads](https://camo.githubusercontent.com/25d435553a5276853e42e898570c6546928f1ee0e7980b528fd8f97c3aa9044f/68747470733a2f2f706f7365722e707567782e6f72672f636f64653731312f736f6c72746f6f6c732f642f746f74616c2e737667)](https://packagist.org/packages/code711/solrtools)[![Monthly Downloads](https://camo.githubusercontent.com/9678da812ee6343c85d44e357ae4f5a55b6d113cde27fd2481bf9f20799abe1e/68747470733a2f2f706f7365722e707567782e6f72672f636f64653731312f736f6c72746f6f6c732f642f6d6f6e74686c79)](https://packagist.org/packages/sudhaus7/logformatter)[![PHPSTAN:Level 9](https://camo.githubusercontent.com/dbacde0a3c3ca60b2cb84e5c977cbb24f1bdffea8565bce48617c23b13d812a8/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048505374616e2d6c6576656c253230392d627269676874677265656e2e7376673f7374796c653d666c6174253544)](https://camo.githubusercontent.com/dbacde0a3c3ca60b2cb84e5c977cbb24f1bdffea8565bce48617c23b13d812a8/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048505374616e2d6c6576656c253230392d627269676874677265656e2e7376673f7374796c653d666c6174253544)[![build:passing](https://camo.githubusercontent.com/989e45ca817066fe8c5d1460cb806846261eaf6753be5021bb809440ff2e9c0c/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6275696c642d70617373696e672d627269676874677265656e2e7376673f7374796c653d666c6174253544)](https://camo.githubusercontent.com/989e45ca817066fe8c5d1460cb806846261eaf6753be5021bb809440ff2e9c0c/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6275696c642d70617373696e672d627269676874677265656e2e7376673f7374796c653d666c6174253544)[![Psalm coverage](https://camo.githubusercontent.com/715e8eb7b7cbbc331e2735aa9b9995db3ceb499d9a5f3b5037b6b956df2679c3/68747470733a2f2f73686570686572642e6465762f6769746875622f73756468617573372f7479706f332d6c6f67666f726d61747465722f636f7665726167652e737667)](https://camo.githubusercontent.com/715e8eb7b7cbbc331e2735aa9b9995db3ceb499d9a5f3b5037b6b956df2679c3/68747470733a2f2f73686570686572642e6465762f6769746875622f73756468617573372f7479706f332d6c6f67666f726d61747465722f636f7665726167652e737667) This Extension provides CLI Tools to initialize the EXT:solr index queues from the command line, and to scan for file-references in the content to add the corresponding sites to the sys\_file metadata where a file is being used. The tools are aimed for installations with multiple sites. They will not do anything what could not be done in the TYPO3 Backend, but might save some time, or might be usefull in certain CI/CD Situations. Additionally, a SolrEntityInterface is available for Extbase Models to update the solr index of a record if it has been changed through extbase in the frontend (similar to EXT:slug\_extbase ) Changelog --------- [](#changelog) 2.0.8 - added command solr:tools:indexqueueworker - this runs the indexer on all sites 2.0.1 - Support of TYPO3 v11-v12 - SolrfilemetaCommand.php does not set 'enable\_indexing' for files on hidden pages or pages with restricted FE user access anymore 2.0.0 - Support of TYPO3 v11-v12 - SolrfilemetaCommand.php does not set 'enable\_indexing' for files on hidden pages or pages with restricted FE user access anymore 1.2.0 - better handling of non-solr-configured sites - added possibility to use the keyword 'all' with option -w/--what to create indexes for all configured tables in a site 1.1.1 - better identifier for events 1.1.0 - added `Code711\SolrTools\Interfaces\SolrEntityInterface` to enable Extbase models to update its index when persisted through extbase 1.0.2 - added promised but missing scan for file-references in tt\_content:header\_link 1.0.1 - Updated TER Description 1.0.0 - Initial release `Code711\SolrTools\Interfaces\SolrEntityInterface` -------------------------------------------------- [](#code711solrtoolsinterfacessolrentityinterface) To enable this feature for your models simply add to the models class definition of your model, for example: ``` class MyModel extends TYPO3\CMS\Extbase\DomainObject\AbstractEntity implements \Code711\SolrTools\Interfaces\SolrEntityInterface ``` now when persisting an object of this class, it will check if it is indexed in solr and if yes that its index will be added or updated through the normal scheduler process. The Interface itself has no further requirements and is only used as a marker to identify the models to watch out for. solr:tools:createindex ---------------------- [](#solrtoolscreateindex) ``` ./vendor/bin/typo3 solr:tools:createindex --help Description: This tool creates (re)index tasks for solr per table and site or all sites Usage: solr:tools:createindex [options] [--] ... Arguments: site Site identifier or ALL for all sites Options: -w, --what=WHAT what to index (eq pages) (multiple values allowed). Enter "all" to index all configured pages -c, --cleanup clean the solr index per site -h, --help Display help for the given command. When no command is given display help for the list command -q, --quiet Do not output any message -V, --version Display this application version --ansi|--no-ansi Force (or disable --no-ansi) ANSI output -n, --no-interaction Do not ask any interactive question -v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug ``` This tool expects [EXT:solr](https://extensions.typo3.org/extension/solr) to be set up and configured in TYPO3. ### Examples [](#examples) This will create index-tasks for the table pages in all Sites and it will run cleanup before that ``` ./vendor/bin/typo3 solr:tools:createindex -w pages --cleanup ALL ``` This will create index-tasks for the tables tx\_news and sys\_file\_metadata in the sites with the identifiers customer1 and customer3 ``` ./vendor/bin/typo3 solr:tools:createindex -w tx_news -w sys_file_metadata customer1 customer3 ``` The following will create index tasks for all tables in all sites ``` ./vendor/bin/typo3 solr:tools:createindex -w all all ``` solr:tools:filemeta ------------------- [](#solrtoolsfilemeta) This tool will search the file references table and the header\_link and bodytext fields for files which match the given file extensions. It will then look up the corresponding site based on the page-id associated with the record and add that site id to the enable\_indexing field provided by [EXT:solr\_file\_indexer](https://extensions.typo3.org/extension/solr_file_indexer). The tool will check if the element is visible (deleted=0, hidden=0) and if the page and its parent pages are visible, to ensure only 'active' files are added to the solr index. ``` ./vendor/bin/typo3 solr:tools:filemeta --help Description: This tool searches for relations of files in the database and adds the correct site reference in the Files metadata, in order for EXT:solr to index those files correctly Usage: solr:tools:filemeta [options] Options: --ext[=EXT] File extensions to allow [default: ["doc","docx","pdf"]] (multiple values allowed) -c, --cleanup clean the site field in all meta data -h, --help Display help for the given command. When no command is given display help for the list command -q, --quiet Do not output any message -V, --version Display this application version --ansi|--no-ansi Force (or disable --no-ansi) ANSI output -n, --no-interaction Do not ask any interactive question -v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug ``` ### Health Score 45 — FairBetter than 93% of packages Maintenance64 Regular maintenance activity Popularity26 Limited adoption so far Community9 Small or concentrated contributor base Maturity67 Established project with proven stability Bus Factor1 Top contributor holds 88.9% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~50 days Recently: every ~0 days Total 23 Last Release 80d ago Major Versions 1.2.0 → 2.0.02023-09-12 2.0.11 → 3.0.02026-02-27 PHP version history (4 changes)1.0.0PHP 7.4.\*||8.0.\*||8.1.\*||8.2.\* 2.0.0PHP 8.0.\*||8.1.\*||8.2.\* 2.0.3PHP 8.0.\*||8.1.\*||8.2.\*||8.3.\* 3.0.0PHP ^8.2 ### Community Maintainers ![](https://www.gravatar.com/avatar/35fe42b338d9a56b03685815a4d6b198d7d78be7d75859f0e8978c88f4605afe?d=identicon)[code711](/maintainers/code711) --- Top Contributors [![foppelfb](https://avatars.githubusercontent.com/u/7147768?v=4)](https://github.com/foppelfb "foppelfb (32 commits)")[![dsimon-dsimon](https://avatars.githubusercontent.com/u/35999103?v=4)](https://github.com/dsimon-dsimon "dsimon-dsimon (4 commits)") --- Tags solrtypo3 ### Code Quality Static AnalysisPsalm Type Coverage Yes ### Embed Badge ![Health badge](/badges/code711-solrtools/health.svg) ``` [![Health](https://phpackages.com/badges/code711-solrtools/health.svg)](https://phpackages.com/packages/code711-solrtools) ``` ### Alternatives [helhum/typo3-console A reliable and powerful command line interface for TYPO3 CMS 2939.0M192](/packages/helhum-typo3-console)[apache-solr-for-typo3/solr Apache Solr for TYPO3 - Apache Solr for TYPO3 is the enterprise search server you were looking for with special features such as Faceted Search or Synonym Support and incredibly fast response times of results within milliseconds. 1473.0M32](/packages/apache-solr-for-typo3-solr)[hmmh/solr-file-indexer Solr file indexer for Typo3 13217.4k3](/packages/hmmh-solr-file-indexer)[b13/make Kickstarter CLI tool for various TYPO3 functionalities 47250.0k1](/packages/b13-make)[in2code/powermail Powermail is a well-known, editor-friendly, powerful and easy to use mailform extension for TYPO3 with a lots of features 982.5M38](/packages/in2code-powermail)[typo3/testing-framework The TYPO3 testing framework provides base classes for unit, functional and acceptance testing. 675.0M775](/packages/typo3-testing-framework) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)