Skip to content

Repository files navigation

Immich Swipe

GitHub release (latest by date) GitHub License Kotlin Android

Version française ici

Immich Swipe is an open-source Android application designed to make sorting your photos and videos hosted on your Immich server easy and fun.

Inspired by the Sponge app (similar concept for local files), it allows you to quickly sort your media using simple swipe gestures, featuring a smooth and modern interface.

Note: This project started as a personal need and was developed with the help of AI. Although I am not a developer by trade, I place great importance on stability and user experience.

Disclaimer: This is an independent project and is not affiliated in any way with the official Immich project.

📸 Overview

Home Screen Sorting Stack Review Mode Usage Stats
Browse your albums Swipe to decide Check before deleting See what you have achieved
🌙 View Dark Mode Gallery
Home Screen (Dark) Sorting Stack (Dark) Review Mode (Dark) Usage Stats (Dark)

✨ Features

  • 🚀 Fast Sorting Stack: Swipe right to keep, left to delete. Sorted assets disappear from the timeline in real-time for a cleaner experience.
  • 🕒 Snooze (SKIP): Unsure? Skip it. Assets automatically reappear after a configurable delay (1 day, 1 month, or never).
  • 📁 Collections (Virtual Albums): Access special groups like the SKIPs Collection to review all your skipped items in one place.
  • 📊 Global Usage Stats: Visualize your progress with detailed statistics and a breakdown of your sorting actions.
  • 🛡️ Advanced Review Mode: Review all your decisions (delete, keep, archive, lock) and see estimated reclaimed space before syncing.
  • 🔄 Multi-Account Support: Switch between different users seamlessly; your local decisions and progress are preserved for each account.
  • 🗃️ Database Management: Export, import, or clear your local database (globally or per user) to safeguard your sorting data.
  • 🚦 Connection Diagnostic: Real-time status indicator, HTTP/direct IP support, and in-app logs for easy troubleshooting.
  • 🎨 Modern Interface: Jetpack Compose and Material Design 3, with support for English, French, and Spanish.

⚙️ Configuration

  1. Enter your Immich server URL (e.g., https://immich.your-domain.com).
  2. Enter your Immich API Key (if you don't have it already, create one here)
    • Required Permissions: For the app to function correctly, your API key must have the following permissions:
      • user.read
      • album.read
      • asset.read
      • asset.view
      • asset.delete
      • asset.statistics
      • asset.update (Optional --> if you want to archive assets, add them to favourites or to locked folder)
      • userProfileImage.read (Optional --> to show user profile image)
  3. Select an album and start sorting!

📦 Installation

Obtainium Direct Download IzzyOnDroid / F-Droid
Get it on Obtainium Get the latest APK from the Releases section Coming soon, hopefully

🛠️ Build

If you want to compile the application yourself:

  • JDK 17 or higher required.
  • Android Studio (Ladybug version or newer recommended).
  • Clone the repository and import the project into Android Studio.
  • Sync Gradle
  • Use ./gradlew assembleDebug to generate a test APK.

📄 License

This project is licensed under the GNU GPL v3. See the LICENSE file for more details.

⚖️ Disclaimer

While this project is developed with care and tested regularly, I cannot guarantee absolute data safety. By using Immich Swipe, you acknowledge that the author shall not be held liable for any data loss or accidental deletion of media.

Please keep in mind:

  • Trash Safety: Immich Swipe never empties the trash on your Immich server. If you make a mistake while sorting, your photos remain recoverable through the official Immich interface during the configured trash retention period.
  • Principle of Least Privilege: To minimize risks, it is highly recommended to configure your API key with only the strictly required permissions listed in the Configuration section.

About

Android application to quickly review and clean Immich albums / folders using simple swipe gestures.

Topics

Resources

Stars

33 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages