https://github.com/swiftmade/statamic-clear-assets
Clean up unused images and assets from your Statamic site. Saves storage, keep things tidy.
https://github.com/swiftmade/statamic-clear-assets
laravel php statamic statamic-addon statamic-v3 statamic-v4 statamic-v5
Last synced: about 1 month ago
JSON representation
Clean up unused images and assets from your Statamic site. Saves storage, keep things tidy.
- Host: GitHub
- URL: https://github.com/swiftmade/statamic-clear-assets
- Owner: swiftmade
- License: mit
- Created: 2022-05-14T16:25:01.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-09-13T18:00:36.000Z (5 months ago)
- Last Synced: 2025-10-22T08:42:03.657Z (4 months ago)
- Topics: laravel, php, statamic, statamic-addon, statamic-v3, statamic-v4, statamic-v5
- Language: PHP
- Homepage:
- Size: 875 KB
- Stars: 18
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Statamic Clear Assets
[](https://packagist.org/packages/swiftmade/statamic-clear-assets)
> Supports Statamic 3, 4 and 5.
Clean up unused images and assets from your Statamic site. Saves storage, keep things tidy.
The addon scans your entire `content` and `users` directory. If an asset is not referenced anywhere, it will be marked as unused. You can review the list of unused assets and delete them.
The addon is easy to configure. See the [Configuration](#configuration) section below.
## How to Install
You can search for this addon in the `Tools > Addons` section of the Statamic control panel and click **install**, or run the following command from your project root:
```bash
composer require swiftmade/statamic-clear-assets
```
## How to Use
Simply run:
```bash
php please assets:clear
```
It will list all the assets that are not referenced anywhere in your content directory. You can delete them all at once, or one by one.
If you want to skip the interactive mode, you can use the `--force` flag:
```bash
# This will delete all the unused assets without asking for confirmation!
php please assets:clear --force=true
```
## Configuration
To publish the config file, use:
```bash
php artisan vendor:publish --tag=statamic-clear-assets-config
```
Here's all of the configuration options with their defaults:
```php
return [
/**
* Where should we look to see if assets are still referenced or not?
* If you're referencing assets elsewhere in your codebase, add those paths here.
* All paths are relative to the base_path()
*/
'scan_folders' => [
'content',
'users',
],
/**
* All assets from these containers will be left alone.
* You can see all your asset containers under content/assets folder.
*/
'ignore_containers' => [
'favicons',
'social_images',
],
/**
* If we come across these filenames, we'll just leave them alone.
* You can use "*" as a wildcard. eg: "IMAGE*.jpg" will ignore IMAGE1.jpg IMAGE23.jpg etc...
*/
'ignore_filenames' => [
//
],
/**
* You might not want to delete very fresh assets, as perhaps you want to use them soon.
* Use this config to only detect and delete files older than x days.
*/
'minimum_age_in_days' => 0,
];
```
## Common Questions
**It's deleting assets that I'm referencing in my antlers templates!**
If you want to ignore the assets referenced in your views, add `resources/views` to the `scan_folders` config. Keep in mind that this will only work if the filename is mentioned verbatim in the code. If you are using variables or other logic to reference the asset, the addon might not be able to detect that the asset is being used.
**How do I always keep PDF files?**
Add `*.pdf` to the `ignore_filenames` config.
**How do I always keep assets from a specific container?**
Add the container's slug to the `ignore_containers` config.
**How do I only delete assets older than 30 days?**
Set `minimum_age_in_days` to `30` in the config.