# AGENTS.md — Build guide for CleanMyMac ## Project scope Scan explicitly selected folders, group large files and cache candidates, and preview exact paths before moving approved files to Trash. Explain sync-folder consequences and leave system cleanup outside scope. Catalogue verdict: kinda. The core loop is buildable, but a dependable replacement becomes a real weekend or multi-day project. For CleanMyMac, surface large files, caches, login items, and safe cleanup suggestions without deleting automatically. The hard boundary is os-specific cleanup knowledge, malware scanning, updater integrations, and support, plus os integration polish and maintenance. Use the implementation prompt below to define the deliverable. Complete each phase's acceptance checks before extending the scope. ## Working agreement - Inspect the repository and its existing instructions before choosing paths, dependencies or commands. Keep one coherent stack and explain changes to the proposed architecture. - Plan a vertical slice that accepts a real input and produces the useful output described below. Persist only the state the prompt calls for; respect memory-only and upstream-managed workflows. Use fixtures only when they are clearly labelled. - After scaffolding, document the actual install, development, check and build commands in README and keep them synchronized with the package or project manifest. Do not report commands as successful unless they ran. - Work in small steps. At handoff, list implemented flows, checks actually performed, remaining blockers, and any credentials or provider setup the owner must supply. - Do not publish, spend money, contact customers, delete source data or run irreversible migrations without the project owner's authorization. ## Prerequisites - macOS, Xcode and a selected deployment target. Ask for each OS permission only when its feature is enabled; code signing and distribution are separate release tasks. Only user-selected scan folders and an available Trash destination are needed; no full-disk cleanup privilege is required. - Implementation components: Swift, SwiftUI and focused AppKit integrations for a macOS utility. SQLite or Codable files for local settings and history; macOS Keychain for credentials. - Scope boundary: OS-specific cleanup knowledge, malware scanning, updater integrations, and support; years of OS-version edge cases ## Stack and architecture - Swift, SwiftUI and focused AppKit integrations for a macOS utility. - SQLite or Codable files for local settings and history; macOS Keychain for credentials. - Domain model: user-selected scan roots, file paths, sizes, modification times and proposed Trash actions ## Security and data integrity - Use user-selected folder access and resolve each exact target immediately before a confirmed move to Trash. Reject symlink/path escapes, preserve files changed since preview and keep a visible cancel control. Never delete automatically or request broad disk permissions for a narrow folder scan. - Correctness boundary: No automatic deletion, shell-built paths or recursive cleanup outside the selected root; recheck file identity before each move. - Keep UI state on the main actor, cancel obsolete background tasks, and avoid blocking system callbacks. Record only the selected feature scope, with clear retention controls. - Export settings and explicitly selected history without secrets. Preserve the last working configuration and provide a reset that does not delete user source files. ## Agent implementation rules - Project rule — data model: user-selected scan roots, file paths, sizes, modification times and proposed Trash actions - Project rule — preserve this invariant: No automatic deletion, shell-built paths or recursive cleanup outside the selected root; recheck file identity before each move. - Project rule — acceptance evidence: A file changed since preview is skipped for review; cancelling a cleanup leaves all files untouched and an allowed move remains recoverable from Trash. ## Optional agent skills and references - Optional external skill: [swiftui-expert-skill](https://github.com/AvdLee/SwiftUI-Agent-Skill/blob/main/skills/swiftui-expert-skill/SKILL.md) — Build and review native SwiftUI views, state management, navigation, accessibility and rendering performance. Review its instructions and compatibility before use; it does not grant deployment, data-access or publication permission. - Optional external skill: [swift-concurrency](https://github.com/AvdLee/Swift-Concurrency-Agent-Skill/blob/main/skills/swift-concurrency/SKILL.md) — Design Swift async tasks, actors, isolation, cancellation and safe data sharing, including Swift 6 migration. Review its instructions and compatibility before use; it does not grant deployment, data-access or publication permission. - Optional external skill: [sharp-edges](https://github.com/trailofbits/skills/blob/main/plugins/sharp-edges/skills/sharp-edges/SKILL.md) — Review security-sensitive APIs and configuration for dangerous defaults and easy-to-misuse interfaces. Review its instructions and compatibility before use; it does not grant deployment, data-access or publication permission. Read the linked SKILL.md and its dependencies before adding a skill. Select only the skills matching this project's runtime and task; their documentation does not supply API access, credentials or approval to perform external actions. Pin the reviewed revision where the tool supports it. Follow the chosen agent's documented project-level installation mechanism. ## Distribution ideas These are optional planning notes. Obtain the owner's approval before publishing or contacting anyone. - Demonstrate the actual CleanMyMac-inspired workflow with owned or clearly labeled sample data: Scan explicitly selected folders, group large files and cache candidates, and preview exact paths before moving approved files to Trash. Explain sync-folder consequences and leave system cleanup outside scope. - Publish a reproducible walkthrough with this observable result: A file changed since preview is skipped for review; cancelling a cleanup leaves all files untouched and an allowed move remains recoverable from Trash. - Explain who can operate this scoped tool, its setup and ongoing costs, and these remaining product gaps: OS-specific cleanup knowledge, malware scanning, updater integrations, and support; years of OS-version edge cases Avoid guaranteed savings, performance scores or implied endorsement. ## Engineering roadmap 1. Phase 1 — Scope and fixtures. Implement this bounded workflow: Scan explicitly selected folders, group large files and cache candidates, and preview exact paths before moving approved files to Trash. Explain sync-folder consequences and leave system cleanup outside scope. Record prerequisites, select representative user-owned fixtures and document the unsupported features: OS-specific cleanup knowledge, malware scanning, updater integrations, and support; years of OS-version edge cases 2. Phase 2 — Durable model. Model user-selected scan roots, file paths, sizes, modification times and proposed Trash actions Add migrations or a versioned document format, explicit validation, stable IDs and a visible import-error report. Preserve this rule: No automatic deletion, shell-built paths or recursive cleanup outside the selected root; recheck file identity before each move. 3. Phase 3 — Complete the first useful path. Implement the workflow's input, review and output interface, with clear controls and explicit empty/error states. Keep UI state on the main actor, cancel obsolete background tasks, and avoid blocking system callbacks. Record only the selected feature scope, with clear retention controls. 4. Phase 4 — Permissions and integration failure. Use user-selected folder access and resolve each exact target immediately before a confirmed move to Trash. Reject symlink/path escapes, preserve files changed since preview and keep a visible cancel control. Never delete automatically or request broad disk permissions for a narrow folder scan. Request integration credentials and permissions only for the enabled feature; show a disconnected state instead of mock results. 5. Phase 5 — Portable handoff. Export settings and explicitly selected history without secrets. Preserve the last working configuration and provide a reset that does not delete user source files. Include setup, operating limits, fixture walkthrough and shutdown/restart instructions in the README. 6. Phase 6 — Acceptance scenarios. A file changed since preview is skipped for review; cancelling a cleanup leaves all files untouched and an allowed move remains recoverable from Trash. Repeat the workflow after restart and with a denied permission or unavailable dependency; show recoverable failure rather than a success placeholder. ## Paid-product capabilities outside this build - OS-specific cleanup knowledge, malware scanning, updater integrations, and support - years of OS-version edge cases - large extension ecosystem - cross-device sync - commercial support and rapid compatibility fixes ## Implementation prompt WORKING SLICE Scan explicitly selected folders, group large files and cache candidates, and preview exact paths before moving approved files to Trash. Explain sync-folder consequences and leave system cleanup outside scope. Build this scoped CleanMyMac-inspired workflow with a documented data model and visible failure states. Architecture - Swift, SwiftUI and focused AppKit integrations for a macOS utility. - SQLite or Codable files for local settings and history; macOS Keychain for credentials. Prerequisites and limits macOS, Xcode and a selected deployment target. Ask for each OS permission only when its feature is enabled; code signing and distribution are separate release tasks. Only user-selected scan folders and an available Trash destination are needed; no full-disk cleanup privilege is required. Outside this release: OS-specific cleanup knowledge, malware scanning, updater integrations, and support; years of OS-version edge cases Data model and correctness user-selected scan roots, file paths, sizes, modification times and proposed Trash actions Invariant: No automatic deletion, shell-built paths or recursive cleanup outside the selected root; recheck file identity before each move. Keep UI state on the main actor, cancel obsolete background tasks, and avoid blocking system callbacks. Record only the selected feature scope, with clear retention controls. Security and privacy Use user-selected folder access and resolve each exact target immediately before a confirmed move to Trash. Reject symlink/path escapes, preserve files changed since preview and keep a visible cancel control. Never delete automatically or request broad disk permissions for a narrow folder scan. Recovery and export Export settings and explicitly selected history without secrets. Preserve the last working configuration and provide a reset that does not delete user source files. Implementation order 1. Phase 1 — Scope and fixtures. Implement this bounded workflow: Scan explicitly selected folders, group large files and cache candidates, and preview exact paths before moving approved files to Trash. Explain sync-folder consequences and leave system cleanup outside scope. Record prerequisites, select representative user-owned fixtures and document the unsupported features: OS-specific cleanup knowledge, malware scanning, updater integrations, and support; years of OS-version edge cases 2. Phase 2 — Durable model. Model user-selected scan roots, file paths, sizes, modification times and proposed Trash actions Add migrations or a versioned document format, explicit validation, stable IDs and a visible import-error report. Preserve this rule: No automatic deletion, shell-built paths or recursive cleanup outside the selected root; recheck file identity before each move. 3. Phase 3 — Complete the first useful path. Implement the workflow's input, review and output interface, with clear controls and explicit empty/error states. Keep UI state on the main actor, cancel obsolete background tasks, and avoid blocking system callbacks. Record only the selected feature scope, with clear retention controls. 4. Phase 4 — Permissions and integration failure. Use user-selected folder access and resolve each exact target immediately before a confirmed move to Trash. Reject symlink/path escapes, preserve files changed since preview and keep a visible cancel control. Never delete automatically or request broad disk permissions for a narrow folder scan. Request integration credentials and permissions only for the enabled feature; show a disconnected state instead of mock results. 5. Phase 5 — Portable handoff. Export settings and explicitly selected history without secrets. Preserve the last working configuration and provide a reset that does not delete user source files. Include setup, operating limits, fixture walkthrough and shutdown/restart instructions in the README. 6. Phase 6 — Acceptance scenarios. A file changed since preview is skipped for review; cancelling a cleanup leaves all files untouched and an allowed move remains recoverable from Trash. Repeat the workflow after restart and with a denied permission or unavailable dependency; show recoverable failure rather than a success placeholder. Acceptance A file changed since preview is skipped for review; cancelling a cleanup leaves all files untouched and an allowed move remains recoverable from Trash. Use real source data or clearly labeled fixtures. Explain unsupported input and provider failures; do not fabricate analytics, delivery receipts, accuracy claims or security guarantees. Optional agent guidance Optional external skill: [swiftui-expert-skill](https://github.com/AvdLee/SwiftUI-Agent-Skill/blob/main/skills/swiftui-expert-skill/SKILL.md) — Build and review native SwiftUI views, state management, navigation, accessibility and rendering performance. Review its instructions and compatibility before use; it does not grant deployment, data-access or publication permission. Optional external skill: [swift-concurrency](https://github.com/AvdLee/Swift-Concurrency-Agent-Skill/blob/main/skills/swift-concurrency/SKILL.md) — Design Swift async tasks, actors, isolation, cancellation and safe data sharing, including Swift 6 migration. Review its instructions and compatibility before use; it does not grant deployment, data-access or publication permission. Optional external skill: [sharp-edges](https://github.com/trailofbits/skills/blob/main/plugins/sharp-edges/skills/sharp-edges/SKILL.md) — Review security-sensitive APIs and configuration for dangerous defaults and easy-to-misuse interfaces. Review its instructions and compatibility before use; it does not grant deployment, data-access or publication permission. Project rule — data model: user-selected scan roots, file paths, sizes, modification times and proposed Trash actions Project rule — preserve this invariant: No automatic deletion, shell-built paths or recursive cleanup outside the selected root; recheck file identity before each move. Project rule — acceptance evidence: A file changed since preview is skipped for review; cancelling a cleanup leaves all files untouched and an allowed move remains recoverable from Trash. ## Completion evidence Demonstrate the prompt's acceptance scenarios against the scoped workflow. Include setup from a clean checkout and failure recovery. Check persistence across restart and export/restore only for the state the prompt says to store; for memory-only tools, confirm that temporary content is discarded as specified. Record actual results and remaining limitations. A detailed plan alone does not establish a working replacement.