You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Hass-Cleaner is a Home Assistant App for inspecting storage, stale entities and registry relationships before anything is cleaned up. Safety, evidence and recovery come before reclaimed space.
5
+
Hass-Cleaner is a Home Assistant App for inspecting storage, stale entities and registry relationships before anything is cleaned up. Safety, informed user choice and recovery come before reclaimed space.
6
6
7
-
> **Release status:** version 1.0.1 is the current maintenance release for controlled early testing. Hass-Cleaner provides facts, advice, backup options and recovery guidance; the user makes the final cleanup decision.
7
+
> **Release status:** version 1.0.1 is the current maintenance release for controlled early use. Hass-Cleaner provides facts, advice, backup options and recovery guidance; the user makes the final cleanup decision.
8
+
9
+
## English
8
10
9
11
> [!WARNING]
10
-
> **Testversie — voorzichtig gebruiken / Test version — handle with care.** Hass-Cleaner kan bestanden, Home Assistant-registerobjecten en Recorder-gegevens wijzigen. Controleer iedere selectie en maak vooraf bij voorkeur een volledige Home Assistant-back-up. Test bij voorkeur eerst op een niet-kritische installatie. Gebruik is op eigen risico; quarantaine en herstelvoorzieningen verkleinen het risico, maar kunnen niet garanderen dat iedere integratie of gebruikersconfiguratie zonder gevolgen blijft werken.
11
-
>
12
-
> Hass-Cleaner can modify files, Home Assistant registry objects and Recorder data. Review every selection and preferably create a full Home Assistant backup first. Test on a non-critical installation where possible. Use is at your own risk; quarantine and recovery safeguards reduce risk, but cannot guarantee that every integration or user configuration remains unaffected.
12
+
> **Test version — handle with care.** Hass-Cleaner can modify files, Home Assistant registry objects and Recorder data. Review every selection and preferably create a full Home Assistant backup first. Test on a non-critical installation where possible. Use is at your own risk; quarantine and recovery safeguards reduce risk, but cannot guarantee that every integration or user configuration remains unaffected.
13
13
14
-
##Nederlands
14
+
### What is Hass-Cleaner?
15
15
16
-
### Wat is Hass-Cleaner?
16
+
Hass-Cleaner helps Home Assistant users review accumulated data in a clear and controlled way. It can identify old logs, rebuildable cache files, persistently unavailable entities and inconsistent registry relationships.
17
17
18
-
Hass-Cleaner helpt Home Assistant-gebruikers om vervuiling begrijpelijk en gecontroleerd te beoordelen. De app zoekt onder andere naar oude logs, opnieuw op te bouwen cachebestanden, langdurig onbeschikbare entities en afwijkende registerrelaties.
18
+
A finding is never treated as deletion evidence by itself. The App explains why it was found, its risk, possible consequences and the available recovery path.
19
19
20
-
Een gevonden item is nooit automatisch verwijderbewijs. De app toont waarom iets is gevonden, wat het risico is, wat er kan gebeuren en hoe herstel werkt.
20
+
### Main features
21
21
22
-
### Belangrijkste functies
22
+
- Safe storage scanning with one clear export dialog: a readable Markdown report, CSV for spreadsheet analysis and JSON for technical analysis.
23
+
- Beginner-friendly cleanup categories and a clear **Prepare cleanup** action.
24
+
- Entity filters for state, duration, integration, device and area.
25
+
- Device and entity grouping by integration or device.
26
+
- Scan differences for new, changed, recovered and disappeared signals.
27
+
- Official Home Assistant Recorder purge with separate confirmation.
28
+
- Quarantine for safe, personal and explicitly user-reviewed files; protected core files remain excluded.
29
+
- User-directed removal of registered entities and supported device bundles through Home Assistant's official API.
30
+
- Clearable local scan and completed-quarantine logs for a clean start.
31
+
- Restore testing and recovery without overwriting existing files.
23
32
24
-
- Veilige opslagscan met één duidelijk exportvenster: een leesbaar Markdownrapport, CSV voor Excel en JSON voor technische analyse.
25
-
- Begrijpelijke opruimcategorieën en de actie **Opschoning voorbereiden**.
26
-
- Entities filteren op status, duur, integratie, apparaat en ruimte.
27
-
- Apparaten en entities bundelen per integratie of apparaat.
28
-
- Verschillen tussen scans: nieuw, gewijzigd, hersteld en verdwenen.
29
-
- Officiële Home Assistant Recorder-purge met afzonderlijke bevestiging.
30
-
- Quarantaine voor veilige, persoonlijke en door de gebruiker beoordeelde bestanden; beschermde kernbestanden blijven uitgesloten.
31
-
- Gebruikersgestuurde verwijdering van geregistreerde entities en ondersteunde apparaatbundels via de officiële Home Assistant-API.
32
-
- Wisbare lokale scan- en afgeronde quarantainelogboeken voor een schone start.
33
-
- Hersteltest en terugplaatsen zonder bestaande bestanden te overschrijven.
33
+
### 1.0.x safety model
34
34
35
-
### Veiligheidsmodel van 1.0.x
35
+
A file can enter quarantine only when all conditions are satisfied:
36
36
37
-
Een bestand kan alleen naar quarantaine als aan alle voorwaarden wordt voldaan:
37
+
1. It belongs to the latest completed scan.
38
+
2. Its type, path, age, risk class and protected scopes still match the scan immediately before execution.
39
+
3. Its size, modification time and SHA-256 still match the scan.
40
+
4. The user explicitly chooses a Supervisor-verified backup, a manually checked recent backup or proceeding without a backup.
41
+
5. Deviating from the recommended verified backup requires an additional risk acknowledgement.
42
+
6. The user confirms the operation with `QUARANTAINE`.
38
43
39
-
1. Het bestand komt uit de laatste voltooide scan.
40
-
2. Bestandstype, pad, leeftijd, risicoklasse en beschermde scopes komen nog overeen met de scan.
41
-
3. Grootte, wijzigingstijd en SHA-256 komen overeen met de scan.
42
-
4. De gebruiker kiest bewust voor een door Supervisor geverifieerde back-up, een zelf gecontroleerde recente back-up of doorgaan zonder back-up.
43
-
5. Een afwijking van de aanbevolen geverifieerde back-up vereist een extra risicobevestiging.
44
-
6. De gebruiker bevestigt de actie met `QUARANTAINE`.
44
+
The complete selection is validated before the first file is moved. Quarantine records the original path, checksum, user, backup evidence and expiry time. Recovery requires `HERSTEL` and never overwrites an existing file.
45
45
46
-
De volledige selectie wordt gecontroleerd voordat het eerste bestand wordt verplaatst. Quarantaine bewaart oorsprong, checksum, gebruiker, back-upbewijs en vervaldatum. Herstel vereist `HERSTEL` en overschrijft nooit een bestaand bestand.
46
+
Nothing is deleted automatically after the configured 1–10 day retention period. Permanent removal becomes available only after expiry, verifies the checksum again and requires `VERWIJDER`.
47
47
48
-
Na de ingestelde bewaartermijn van 1–10 dagen wordt niets automatisch gewist. Definitief verwijderen is pas daarna beschikbaar, voert opnieuw een checksumcontrole uit en vereist `VERWIJDER`.
48
+
Personal or uncertain content requires an additional content acknowledgement. Registry cleanup requires displayed advice, a backup choice, risk acknowledgement and exact count confirmation. Runtime-only entities and protected core files remain technically excluded.
49
49
50
-
Persoonlijke of onzekere inhoud vereist een extra inhoudsbevestiging. Registeropschoning vereist adviesweergave, back-upkeuze, risicobevestiging en een exact aantal. Runtime-only entities en beschermde kernbestanden blijven technisch uitgesloten.
50
+
### Documentation
51
51
52
-
### Talen
52
+
The [Hass-Cleaner Wiki](https://github.com/dkwolf1/Hass-Cleaner/wiki) contains the user guide, including:
53
53
54
-
- Interface en Home Assistant App-instellingen: Automatisch, Nederlands en English.
55
-
- Automatisch gebruikt de browser-/Home Assistant-weergavetaal en valt bij een niet-ondersteunde taal terug op Engels.
56
-
- De taalkeuze binnen Hass-Cleaner heeft voorrang op de Home Assistant App-configuratie.
54
+
- installation and updates;
55
+
- the recommended first scan;
56
+
- file classification and quarantine;
57
+
- entity and bundle review;
58
+
- Recorder cleanup and backups;
59
+
- settings, reports and troubleshooting;
60
+
- safety and recovery guidance;
61
+
- a concise Dutch quick-start.
57
62
58
-
### Installeren vanuit GitHub
63
+
For version-specific changes, see [CHANGELOG.md](hass_cleaner/CHANGELOG.md). For planned work and release criteria, see [ROADMAP.md](ROADMAP.md).
59
64
60
-
1. Open Home Assistant en ga naar **Instellingen → Apps → App store → Repositories**.
5. Voer eerst alleen een scan uit en beoordeel het rapport.
65
+
### Languages
65
66
66
-
GitHub Actions bouwt versie 1.0.1 voor `amd64` en `aarch64`. Na publicatie van de container kan Home Assistant de release via deze repository installeren of bijwerken.
67
+
- Project documentation and GitHub communication use English as the primary language and Dutch as the secondary language.
68
+
- Interface and Home Assistant App settings support Automatic, English and Nederlands.
69
+
- Automatic uses the browser or Home Assistant display language and falls back to English for unsupported languages.
70
+
- The language selected inside Hass-Cleaner takes precedence over the Home Assistant App configuration.
67
71
68
-
### Lokaal ontwikkelen en testen
72
+
### Install from GitHub
69
73
70
-
Voer deze opdrachten uit vanuit de map `hass_cleaner`:
74
+
1. In Home Assistant, open **Settings → Apps → App store → Repositories**.
75
+
2. Add `https://github.com/dkwolf1/Hass-Cleaner`.
76
+
3. Install **Hass-Cleaner**.
77
+
4. Start the App and open its web interface.
78
+
5. Run a scan first and review the report before preparing an action.
79
+
80
+
GitHub Actions builds version 1.0.1 for `amd64` and `aarch64`. After the container is published, Home Assistant can install or update the release through this repository.
81
+
82
+
### Local development and tests
83
+
84
+
Run the following commands from the `hass_cleaner` directory:
Lees [ROADMAP.md](ROADMAP.md) voor de resterende releasecriteria.
88
-
89
101
---
90
102
91
-
## English
103
+
## Nederlands
92
104
93
-
### What is Hass-Cleaner?
105
+
> [!WARNING]
106
+
> **Testversie — voorzichtig gebruiken.** Hass-Cleaner kan bestanden, Home Assistant-registerobjecten en Recorder-gegevens wijzigen. Controleer iedere selectie en maak vooraf bij voorkeur een volledige Home Assistant-back-up. Test waar mogelijk eerst op een niet-kritische installatie. Gebruik is op eigen risico; quarantaine en herstelvoorzieningen verkleinen het risico, maar kunnen niet garanderen dat iedere integratie of gebruikersconfiguratie zonder gevolgen blijft werken.
94
107
95
-
Hass-Cleaner helps Home Assistant users review accumulated data in a clear and controlled way. It can identify old logs, rebuildable cache files, persistently unavailable entities and inconsistent registry relationships.
108
+
### Wat is Hass-Cleaner?
96
109
97
-
A finding is never treated as deletion evidence by itself. The App explains why it was found, its risk, possible consequences and the available recovery path.
110
+
Hass-Cleaner helpt Home Assistant-gebruikers om verzamelde gegevens begrijpelijk en gecontroleerd te beoordelen. De App zoekt onder andere naar oude logs, opnieuw op te bouwen cachebestanden, langdurig onbeschikbare entities en afwijkende registerrelaties.
98
111
99
-
### Main features
112
+
Een gevonden onderdeel is nooit automatisch verwijderbewijs. De App toont waarom iets is gevonden, wat het risico is, wat er kan gebeuren en hoe herstel werkt.
100
113
101
-
- Safe storage scanning with one clear export dialog: a readable Markdown report, CSV for Excel and JSON for technical analysis.
102
-
- Beginner-friendly cleanup categories and a clear **Prepare cleanup** action.
103
-
- Entity filters for state, duration, integration, device and area.
104
-
- Device and entity grouping by integration or device.
105
-
- Scan differences for new, changed, recovered and disappeared signals.
106
-
- Official Home Assistant Recorder purge with separate confirmation.
107
-
- Quarantine for safe, personal and explicitly user-reviewed files; protected core files remain excluded.
108
-
- User-directed removal of registered entities and supported device bundles through Home Assistant's official API.
109
-
- Clearable local scan and completed-quarantine logs for a clean start.
110
-
- Restore testing and recovery without overwriting existing files.
114
+
### Belangrijkste functies
111
115
112
-
### 1.0.x safety model
116
+
- Veilige opslagscan met één duidelijk exportvenster: een leesbaar Markdownrapport, CSV voor spreadsheetanalyse en JSON voor technische analyse.
117
+
- Begrijpelijke opruimcategorieën en de actie **Opschoning voorbereiden**.
118
+
- Entities filteren op status, duur, integratie, apparaat en ruimte.
119
+
- Apparaten en entities bundelen per integratie of apparaat.
120
+
- Verschillen tussen scans: nieuw, gewijzigd, hersteld en verdwenen.
121
+
- Officiële Home Assistant Recorder-purge met afzonderlijke bevestiging.
122
+
- Quarantaine voor veilige, persoonlijke en door de gebruiker beoordeelde bestanden; beschermde kernbestanden blijven uitgesloten.
123
+
- Gebruikersgestuurde verwijdering van geregistreerde entities en ondersteunde apparaatbundels via de officiële Home Assistant-API.
124
+
- Wisbare lokale scan- en afgeronde quarantainelogboeken voor een schone start.
125
+
- Hersteltest en terugplaatsen zonder bestaande bestanden te overschrijven.
113
126
114
-
A file can enter quarantine only when all conditions are satisfied:
127
+
### Veiligheidsmodel van 1.0.x
115
128
116
-
1. It belongs to the latest completed scan.
117
-
2. Its type, path, age, risk class and protected scopes still match the scan immediately before execution.
118
-
3. Its size, modification time and SHA-256 still match the scan.
119
-
4. The user explicitly chooses a Supervisor-verified backup, a manually checked recent backup or proceeding without a backup.
120
-
5. Deviating from the recommended verified backup requires an additional risk acknowledgement.
121
-
6. The user confirms the operation with `QUARANTAINE`.
129
+
Een bestand kan alleen naar quarantaine als aan alle voorwaarden wordt voldaan:
122
130
123
-
The entire selection is validated before the first file is moved. Quarantine records the original path, checksum, user, backup evidence and expiry time. Recovery requires `HERSTEL` and never overwrites an existing file.
131
+
1. Het bestand komt uit de laatste voltooide scan.
132
+
2. Bestandstype, pad, leeftijd, risicoklasse en beschermde scopes komen vlak voor uitvoering nog overeen met de scan.
133
+
3. Grootte, wijzigingstijd en SHA-256 komen overeen met de scan.
134
+
4. De gebruiker kiest bewust voor een door Supervisor geverifieerde back-up, een zelf gecontroleerde recente back-up of doorgaan zonder back-up.
135
+
5. Afwijken van de aanbevolen geverifieerde back-up vereist een extra risicobevestiging.
136
+
6. De gebruiker bevestigt de actie met `QUARANTAINE`.
124
137
125
-
Nothing is deleted automatically after the configured 1–10 day retention period. Permanent removal becomes available only after expiry, verifies the checksum again and requires `VERWIJDER`.
138
+
De volledige selectie wordt gecontroleerd voordat het eerste bestand wordt verplaatst. Quarantaine bewaart het oorspronkelijke pad, de checksum, de gebruiker, het back-upbewijs en de vervaldatum. Herstel vereist `HERSTEL` en overschrijft nooit een bestaand bestand.
126
139
127
-
Personal or uncertain content requires an additional content acknowledgement. Registry cleanup requires displayed advice, a backup choice, risk acknowledgement and exact count confirmation. Runtime-only entities and protected core files remain technically excluded.
140
+
Na de ingestelde bewaartermijn van 1–10 dagen wordt niets automatisch gewist. Definitief verwijderen is pas daarna beschikbaar, voert opnieuw een checksumcontrole uit en vereist `VERWIJDER`.
128
141
129
-
### Languages
142
+
Persoonlijke of onzekere inhoud vereist een extra inhoudsbevestiging. Registeropschoning vereist adviesweergave, back-upkeuze, risicobevestiging en een exact aantal. Runtime-only entities en beschermde kernbestanden blijven technisch uitgesloten.
130
143
131
-
- Interface and Home Assistant App settings: Automatic, Dutch and English.
132
-
- Automatic uses the browser/Home Assistant display language and falls back to English for unsupported languages.
133
-
- The language selected inside Hass-Cleaner takes precedence over the Home Assistant App configuration.
144
+
### Documentatie
134
145
135
-
### Install from GitHub
146
+
De [Hass-Cleaner Wiki](https://github.com/dkwolf1/Hass-Cleaner/wiki) bevat de uitgebreide Engelstalige handleiding en een korte Nederlandse snelstart. Onderwerpen zijn onder andere:
136
147
137
-
1. In Home Assistant, open **Settings → Apps → App store → Repositories**.
138
-
2. Add `https://github.com/dkwolf1/Hass-Cleaner`.
139
-
3. Install **Hass-Cleaner**.
140
-
4. Start the App and open its web interface.
141
-
5. Run a scan first and review the report before preparing an action.
148
+
- installatie en updates;
149
+
- de aanbevolen eerste scan;
150
+
- bestandsclassificatie en quarantaine;
151
+
- beoordeling van entities en bundels;
152
+
- Recorder-opschoning en back-ups;
153
+
- instellingen, rapporten en probleemoplossing;
154
+
- veiligheid en herstel.
142
155
143
-
GitHub Actions builds version 1.0.1 for `amd64` and `aarch64`. After the container is published, Home Assistant can install or update the release through this repository.
156
+
Versiegebonden wijzigingen staan in [CHANGELOG.md](hass_cleaner/CHANGELOG.md). Gepland werk en releasecriteria staan in [ROADMAP.md](ROADMAP.md).
144
157
145
-
### Local development and tests
158
+
### Talen
146
159
147
-
Run the following from the `hass_cleaner` directory:
160
+
- Projectdocumentatie en GitHub-communicatie gebruiken Engels als primaire taal en Nederlands als tweede taal.
161
+
- De interface en Home Assistant App-instellingen ondersteunen Automatisch, English en Nederlands.
162
+
- Automatisch gebruikt de browser- of Home Assistant-weergavetaal en valt bij een niet-ondersteunde taal terug op Engels.
163
+
- De taalkeuze binnen Hass-Cleaner heeft voorrang op de Home Assistant App-configuratie.
164
+
165
+
### Installeren vanuit GitHub
166
+
167
+
1. Open in Home Assistant **Instellingen → Apps → App store → Repositories**.
5. Voer eerst een scan uit en beoordeel het rapport voordat je een actie voorbereidt.
172
+
173
+
GitHub Actions bouwt versie 1.0.1 voor `amd64` en `aarch64`. Na publicatie van de container kan Home Assistant de release via deze repository installeren of bijwerken.
174
+
175
+
### Lokaal ontwikkelen en testen
176
+
177
+
Voer de volgende opdrachten uit vanuit de map `hass_cleaner`:
0 commit comments