SwarmUI Preset Deleter v1.0: Bulk T2I Preset Deletion via CLI

[DevNullInc]

Hello SwarmUI community,

I'm releasing a small command-line utility, SwarmUI Preset Deleter v1.0, designed to address a specific need for users managing a large number of Text-to-Image (T2I) presets within SwarmUI.

Background and Motivation:

As some users may have experienced (including myself), importing various preset collections into SwarmUI can lead to a rapid accumulation of presets in the t2i_presets collection of the Users.ldb database. While SwarmUI provides preset management features, bulk deletion of presets is not directly supported, making it a time-consuming task to clear out unwanted presets manually through the UI.

To address this, I developed the SwarmUI Preset Deleter as a command-line tool for efficiently clearing the entire t2i_presets collection.

Technical Details and Functionality:

• Database Interaction: The tool directly interacts with the SwarmUI's LiteDB database file (Users.ldb). It utilizes the LiteDB C# library to connect to the database and execute a targeted deletion operation.
• Target Collection: The utility specifically targets the t2i_presets collection within the Users.ldb database. It is designed to remove all documents within this collection, effectively wiping all Text-to-Image presets.
• Core Logic: The core functionality is implemented in C# and performs the following primary actions:
  1. Prompts for SwarmUI Installation Directory: The tool prompts the user to input the base SwarmUI installation directory.
  2. Constructs Database Path: Dynamically constructs the full path to the Users.ldb file by combining the provided installation directory with the expected relative path (e.g., <InstallDir>/Data/Users.ldb).
  3. Database Connection: Establishes a connection to the LiteDB database at the determined path.
  4. Preset Deletion: Executes the LiteDB command to delete all documents from the t2i_presets collection: _db.GetCollection<Preset>("t2i_presets").DeleteAll();
  5. Output and Feedback: Provides console output to indicate:
     • Initial number of presets found.
     • Number of presets deleted.
     • Confirmation message upon successful deletion.
  6. Error Handling: Includes basic try-catch exception handling, primarily for scenarios such as incorrect directory paths or database access issues.
• Language and Libraries: Developed in C# using the .NET framework and the LiteDB NuGet package for database interaction.
• Target Runtime: Compiled as a executable for Windows 64-bit (win-x64).

Key Features:

• Command-Line Interface (CLI): Designed for direct and efficient execution, suitable for users comfortable with command-line tools.
• Directory Prompt: User-friendly prompt for the SwarmUI installation directory, reducing the need for manual path configuration.
• Clear Output Messages: Provides informative console output to guide the user and confirm the deletion process.
• Self-Contained Executable: Distributable as a single .exe file (and associated DLLs and data files) for easy deployment on Windows.

Important Considerations and Warnings (Data Loss):

This tool is designed for permanent data deletion. It is crucial to understand and acknowledge the following before use:

• Data Backup is Mandatory: Users must back up their Users.ldb file prior to execution. Data recovery after using this tool is only possible from a backup.
• Close SwarmUI: SwarmUI must be completely shut down to prevent file locking and ensure successful database access and modification.
• Intended for Bulk Deletion: The tool is designed to delete all T2I presets. It does not offer selective deletion.

GitHub Release and Download:

The SwarmUI Preset Deleter v1.0 is available for download as a self-contained executable (ZIP archive) on the GitHub Releases page:

https://github.com/DevNullInc/SwarmUI-Preset-Deleter/releases/tag/v1.0

This utility is offered as a basic solution to a specific workflow issue. I welcome feedback from the SwarmUI community, including:

• Bug reports: If you encounter any issues or unexpected behavior, please report them on the GitHub repository.
• Code contributions: Pull requests for improvements, error handling enhancements, or code optimizations are welcome.

This is a simple tool, but hopefully, it can be helpful to SwarmUI users who need to quickly manage their T2I preset collections.

Thank you,

• DevNullInc