PHPackages elementareteilchen/housekeeper - 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. elementareteilchen/housekeeper ActiveTypo3-cms-extension[CLI & Console](/categories/cli) elementareteilchen/housekeeper ============================== CLI commands to keep your TYPO3 instance lean and clean 1.2.2(3mo ago)53.6k↓33.3%2GPL-2.0-or-laterPHPPHP ^8.2 || ^8.3 || ^8.4CI passing Since Mar 13Pushed 3mo ago3 watchersCompare [ Source](https://github.com/ElementareTeilchen/housekeeper)[ Packagist](https://packagist.org/packages/elementareteilchen/housekeeper)[ RSS](/packages/elementareteilchen-housekeeper/feed)WikiDiscussions main Synced 1mo ago READMEChangelogDependencies (5)Versions (16)Used By (0) TYPO3 Housekeeper Commands ========================== [](#typo3-housekeeper-commands) This extension provides various maintenance and housekeeping commands for TYPO3 installations. All commands support the Symfony Console command line interface and can be executed via the TYPO3 CLI. #### Useful Symfony Options [](#useful-symfony-options) OptionDescriptionRequired`--no-interaction / -n`disables interactionNo`--quiet`suppresses outputNo`--silent`no interaction or outputNo`-v / -vv / -vvv`Verbosity levelNoFAL Management Commands ----------------------- [](#fal-management-commands) ### Move Command [](#move-command) Move or rename a file or folder. Works similar to the bash mv command. This could also be done in the Backend, but there is the risk of timeouts on big move operations, which would result in potential chaos. ``` typo3 housekeeper:move ``` #### Parameters [](#parameters) ParameterDescriptionRequired``(Combined) identifier of the source folder/fileYes``(Combined) identifier of the target folder/fileYes> The combined identifier begins with the storage ID, see examples. `:`. The default is `1`. #### Examples [](#examples) ``` # Move a folder to a new location typo3 housekeeper:move old/path other-path/ # Rename a file typo3 housekeeper:move old.pdf new.pdf # Move and rename a folder typo3 housekeeper:move 1:old/path 1:new-path # Move and rename a file typo3 housekeeper:move 1:old.pdf 2:other-path/new.pdf ``` #### Known limitations [](#known-limitations) - Folders can not be moved between storages. Single files do work. Cleanup Commands ---------------- [](#cleanup-commands) These commands find either missing files or files whose identifier contain a specific string and delete them. Files which are still in use are omitted and shown in the output. This will also cleanup leftover references (like in sys\_file\_metadata). ### Limitations [](#limitations) Be aware that the cleanup commands may move files to the recycle bins (`_recycler_` directory). You may want to setup the [appropriate TYPO3 scheduler task.](https://docs.typo3.org/c/typo3/cms-scheduler/main/en-us/Installation/BaseTasks/Index.html)to delete those files automatically. ### Writable Storage Support [](#writable-storage-support) All cleanup commands automatically detect **writable vs. non-writable storages** and adapt their behavior: - **Writable storages**: Creates dummy files before deletion (standard behavior) - **Non-writable storages**: Skips local file operations and deletes directly via TYPO3 FAL API The storage type is determined by checking `isWritable()`. ### Files Cleanup Command [](#files-cleanup-command) Cleanup files via a given identifier. All files matching the given string are deleted via the system's API delete command. Files which are still in use are omitted and shown in the output. ``` typo3 housekeeper:cleanup-files [options] ``` #### Parameters [](#parameters-1) ParameterDescriptionRequired``Files matching this string will be deletedYes#### Options [](#options) OptionShortDescriptionDefault`--storageId``-s`Storage id1 (fileadmin)`--dry-run`-Only pretend deletionfalse`--update-refindex`-Automatically updates the reference indexfalse> Files that failed to be deleted will be written to a log file: `var/log/housekeeper:cleanup-files_failed_DATE.log`. #### Examples [](#examples-1) ``` # delete all files that have .jpg in the identifier typo3 housekeeper:cleanup-files .jpg ``` ### Missing Files Cleanup Command [](#missing-files-cleanup-command) Cleanup missing files. Files marked as missing are touched and marked as not missing before deletion. For good results, make sure you have the Scheduler Task "File Abstraction Layer: Update storage index (scheduler)" actively running. ``` typo3 housekeeper:cleanup-missing [options] ``` #### Options [](#options-1) OptionShortDescriptionDefault`--storageId``-s`Storage id1 (fileadmin)`--dry-run`-Only pretend deletionfalse`--update-refindex`-Automatically updates the reference indexfalse> Files that failed to be deleted will be written to a log file: `var/log/housekeeper:cleanup-missing_failed_DATE.log`. ### SysLog Cleanup Command [](#syslog-cleanup-command) This command deletes entries from sys\_log if they are older than --retentionPeriod and match one of the following criteria: - details LIKE "%has cleared the cache%" - details LIKE "\[scheduler%" - details LIKE "User %s logged in from%" - error > 0 - tstamp older than --cutoffPeriod (default 360) ``` typo3 housekeeper:cleanup-syslog [options] ``` #### Options [](#options-2) OptionShortDescriptionDefault`--cutoffPeriod``-c`Delete rows older than this (in days)360`--retentionPeriod``-r`Keep rows younger than this (in days)10`--dry-run`-Only pretend deletionfalse### Consolidate External URLs Command [](#consolidate-external-urls-command) This command searches for external URLs in the database and converts them to internal TYPO3 links when possible. It can find links (href) and images (src) with a specific path or URL pattern and convert them to internal links (t3: //file?uid= or t3://page?uid=) if the corresponding files or pages can be found. ``` typo3 housekeeper:consolidate-external-urls [options] ``` #### Parameters [](#parameters-2) ParameterDescriptionRequired``The identifier of the siteYes#### Options [](#options-3) OptionShortDescriptionDefault`--table``-t`The database table to search in-`--field``-f`The database field to search in-`--domain``-d`The domain to match (e.g., [www.your-website.com](http://www.your-website.com))-`--path``-p`The path to matchfileadmin`--all``-a`Run on all fields defined in $GLOBALS\['TCA'\]false`--log``-l`Write output to log filefalse`--dry-run`-Only simulate changes without saving themfalse> The `--all` option will use tables and fields found by searching the `$GLOBALS['TCA']` array for all fields with a `type` of `link` or a `softref` containing `typolink`. > The log file option `--log`, causes the output to be written to `var/log/housekeeper:consolidate-external-urls_DATE.log`. #### Examples [](#examples-2) ``` # Convert all external links in the tt_content table, bodytext field typo3 housekeeper:consolidate-external-urls sitename -t tt_content -f bodytext -d www.your-website.com # Convert all external links in all relevant tables and fields typo3 housekeeper:consolidate-external-urls sitename -a -d www.your-website.com # Perform a dry run without making any changes typo3 housekeeper:consolidate-external-urls sitename -t tt_content -f bodytext -d www.your-website.com --dry-run ``` ### Health Score 50 — FairBetter than 96% of packages Maintenance82 Actively maintained with recent releases Popularity29 Limited adoption so far Community15 Small or concentrated contributor base Maturity63 Established project with proven stability Bus Factor1 Top contributor holds 63.6% 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 ~24 days Recently: every ~36 days Total 15 Last Release 96d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/df8a3473fc20df57e5fc0b4e373256c9366493d032736bef52bccea07e94cd18?d=identicon)[elementareteilchen](/maintainers/elementareteilchen) --- Top Contributors [![ri-klein](https://avatars.githubusercontent.com/u/144095794?v=4)](https://github.com/ri-klein "ri-klein (14 commits)")[![franzkugelmann](https://avatars.githubusercontent.com/u/11320147?v=4)](https://github.com/franzkugelmann "franzkugelmann (4 commits)")[![FlorianX](https://avatars.githubusercontent.com/u/525853?v=4)](https://github.com/FlorianX "FlorianX (2 commits)")[![morja](https://avatars.githubusercontent.com/u/29610198?v=4)](https://github.com/morja "morja (1 commits)")[![Zereval](https://avatars.githubusercontent.com/u/103527174?v=4)](https://github.com/Zereval "Zereval (1 commits)") --- Tags typo3typo3-cmstypo3-tools ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/elementareteilchen-housekeeper/health.svg) ``` [![Health](https://phpackages.com/badges/elementareteilchen-housekeeper/health.svg)](https://phpackages.com/packages/elementareteilchen-housekeeper) ``` ### Alternatives [helhum/typo3-console A reliable and powerful command line interface for TYPO3 CMS 2939.0M192](/packages/helhum-typo3-console)[consolidation/annotated-command Initialize Symfony Console commands from annotated command class methods. 22569.8M19](/packages/consolidation-annotated-command)[b13/make Kickstarter CLI tool for various TYPO3 functionalities 47250.0k1](/packages/b13-make)[helhum/typo3-crontab Advanced scheduling for TYPO3 Console commands and TYPO3 Scheduler tasks 3342.9k](/packages/helhum-typo3-crontab)[b13/warmup This extension adds a CLI script to warmup the caches. 12120.6k](/packages/b13-warmup)[namelesscoder/typo3-cms-fluid-precompiler 156.1k](/packages/namelesscoder-typo3-cms-fluid-precompiler) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)