Deep Link Guide

---

This guide documents the currently available deep link actions supported by Pearcleaner. Use these links to trigger specific actions or navigate within the app programmatically.

---

openPearcleaner

• Description: Opens the Pearcleaner app on the main Applications page.
• Example:

  pear://openPearcleaner
  

openSettings

• Description: Opens the settings page. Optionally, navigate to a specific tab by passing a name query item.
• Query Parameters:
  • name (optional): Name of the settings tab (case-insensitive).
• Examples:
  • Open settings:

    pear://openSettings
    

  • Open the "General" settings tab:

    pear://openSettings?name=general
    

openPermissions

• Description: Opens the permissions window.
• Example:

  pear://openPermissions
  
  

uninstallApp

• Description: Uninstalls an app by its name or path.
• Query Parameters:
  • name: Name of the app to uninstall (case-insensitive).
  • path: File path to the app.
  • matchType (optional): Determines how to match the app name. Valid values are:
    • exact: Match the name exactly. This is used by default if matchType is not provided.
    • contains: Match the name partially.
• Examples:
  • Uninstall app by exact name:

    pear://uninstallApp?name=pearcleaner&matchType=exact
    

  • Uninstall app by partial name:

    pear://uninstallApp?name=cleaner&matchType=contains
    

  • Uninstall app by path:

    pear://uninstallApp?path=/Applications/Pearcleaner.app
    

checkOrphanedFiles

• Description: Opens the "Orphaned Files" page.
• Example:

  pear://checkOrphanedFiles
  
  

checkDevEnv

• Description: Opens the development environment page. Optionally, search for a specific environment by name.
• Query Parameters:
  • name (optional): Name of the environment (case-insensitive).
• Examples:
  • Open the development page:

    pear://checkDevEnv
    

  • Search for an environment:

    pear://checkDevEnv?name=xcode
    

appsPaths

• Description: Adds or removes a folder path where to check for .app bundles. Only folder paths are supported.
• Query Parameters:
  • add or remove (required): Specifies the action to perform.
  • path (required): The full path to the folder.
• Examples:
  • Add a folder path:

    pear://appsPaths?add&path=/Users/USER/Applications
    

  • Remove a folder path:

    pear://appsPaths?remove&path=/Users/USER/Applications
    

orphanedPaths

• Description: Adds or removes a path to exclude from orphaned files search. Supports both files and folders.
• Query Parameters:
  • add or remove (required): Specifies the action to perform.
  • path (required): The full path to the file or folder.
• Examples:
  • Add a file or folder path:

    pear://orphanedPaths?add&path=/Users/USER/Documents/file_to_exclude.txt
    

  • Remove a file or folder path:

    pear://orphanedPaths?remove&path=/Users/USER/Documents/file_to_exclude.txt
    

checkUpdates

• Description: Checks for updates and displays the update dialog if available.
• Example:

  pear://checkUpdates
  
  

refreshAppsList

• Description: Refreshes the list of installed apps.
• Example:

  pear://refreshAppsList
  
  

resetSettings

• Description: Resets all user settings to their default values.
• Example:

  pear://resetSettings
  
  

---

Information

• URL Format: Deep links must follow the format:

  pear://<action>?<queryParameters>&<optionals>