SortMeOut Documentation
Welcome to SortMeOut β the intelligent file automation tool for macOS. This documentation will guide you through everything from installation to advanced rule configuration.
Quick Start
Get up and running in minutes with our step-by-step guide.
In-Depth Guides
Learn every feature with comprehensive documentation.
Examples
Ready-to-use rule templates for common scenarios.
Reference
Complete reference for all conditions and actions.
SortMeOut requires macOS 12.0 (Monterey) or later.
Installation
Download & Install
-
Download SortMeOut
Visit sortmeout.saidborna.com and download the latest DMG file. -
Open the DMG
Double-click the downloadedSortMeOut.dmgfile. -
Drag to Applications
Drag the SortMeOut icon to your Applications folder. -
Launch SortMeOut
Open SortMeOut from your Applications folder or Spotlight. -
Grant Permissions
Follow the prompts to grant necessary system permissions.
On first launch, macOS may show a security warning. Right-click the app and select "Open" to bypass this.
Required Permissions
SortMeOut requires specific permissions to monitor and organize your files:
| Permission | Purpose | Required |
|---|---|---|
| Full Disk Access | Monitor all folders and move files between locations | β Yes |
| Notifications | Alert you when files are organized | Recommended |
| Accessibility | Advanced automation features (Shortcuts, AppleScript) | Optional |
Granting Permissions
- Open System Settings (or System Preferences on older macOS)
- Navigate to Privacy & Security
- Select the permission category (e.g., Full Disk Access)
- Click the lock icon and authenticate
- Enable the toggle for SortMeOut
Quick Start Guide
Get your first rule running in under 2 minutes:
-
Add a Watched Folder
Click the menu bar icon β Preferences β Folders β + button.
Select your Downloads folder. -
Create Your First Rule
Go to Rules tab β Click + to create a new rule.
Name it "Organize PDFs". -
Add a Condition
Click "Add Condition" β Select "Extension" β "equals" β type "pdf" -
Add an Action
Click "Add Action" β Select "Move to" β Choose ~/Documents/PDFs -
Activate
Save the rule and toggle it to enabled. Done!
Any PDF file added to Downloads will now automatically move to your PDFs folder.
AI Assistant
SortMeOut includes an intelligent AI assistant powered by Anthropic's Claude to help you organize files more efficiently.
What Can the AI Do?
- Smart Suggestions: Get personalized file organization recommendations based on your folder contents
- Natural Language Rules: Describe what you want in plain English, and the AI creates the rule for you
- File Analysis: Ask questions about your files like "What are the largest files in Downloads?"
- Email Management: Read, search, compose, and send emails directly through chat
- Calendar Access: View and create calendar events from natural language
- Contact Lookup: Search and browse your contacts
- Presentation Builder: Create PowerPoint presentations from a single prompt
- System Control: Adjust volume, brightness, Wi-Fi, Bluetooth, Dark Mode, and 30+ system functions
- Spotlight Search: Search files across your Mac using Spotlight integration
- Notes & Reminders: Create Apple Notes and Reminders from chat
- Cleanup Recommendations: Identify duplicates, old files, and suggest cleanup actions
How to Use
- Click the menu bar icon and select AI Assistant
- Type your question or request in natural language
- Review the AI's suggestions
- Click to apply recommended actions or create suggested rules
Only file names and folder structure are shared with the AIβnever file contents. See our Privacy Policy for details.
AI Usage & Limits
AI requests are subject to daily limits based on your subscription plan.
| Plan | AI Requests | Reset |
|---|---|---|
| Trial | 5 per day | Midnight UTC |
| Pro | 30 per day | Midnight UTC |
You can check your remaining AI requests by clicking the AI Assistant menu itemβthe remaining count is shown in the chat window.
Unused AI requests do not roll over to the next day. Each day's allocation resets at midnight UTC.
Image Studio
SortMeOut includes a built-in Image Studio powered by OpenAI's DALLΒ·E 3 for generating images from text prompts, plus a full suite of image editing tools.
Image Generation
- Text-to-Image: Describe what you want and DALLΒ·E 3 creates it
- Multiple Sizes: Square (1024Γ1024), Landscape (1792Γ1024), Portrait (1024Γ1792)
- Quality Options: Standard and HD quality modes
- Gallery: All generated images are saved locally with full browsing history
Image Editing Tools
- Resize & Crop: Adjust dimensions with custom or preset sizes
- Filters: Blur, sharpen, grayscale, sepia, edge detection, emboss, and more
- Watermark: Add text or image watermarks
- Format Conversion: Convert between PNG, JPEG, WebP, BMP, TIFF
- Batch Processing: Apply edits to multiple images at once
Image Generation Limits
| Plan | Images per Day | Reset |
|---|---|---|
| Trial | 3 per day | Midnight UTC |
| Pro | 3 per day | Midnight UTC |
How to Use
- Click the menu bar icon and select Image Studio
- Enter a text description of the image you want
- Choose size and quality settings
- Click Generate β your image appears in seconds
- Use the editing tools to adjust, or save directly
Plans & Pricing
SortMeOut offers a generous trial and an affordable Pro subscription.
| Feature | Trial (Free) | Pro ($9.99/mo) |
|---|---|---|
| Duration | 7 days | Unlimited |
| File Automation | β Unlimited | β Unlimited |
| Rules & Conditions | β All features | β All features |
| AI Assistant (Claude) | β 5/day | β 30/day |
| Image Studio (DALLΒ·E 3) | β 3/day | β 20/day |
| Email, Calendar & Contacts | β | β |
| Presentation Builder | β | β |
| Priority Support | β | β |
| Future Updates | β | β Included |
After Trial Expires
When your 7-day trial ends:
- Automation continues: Your rules and file watching keep working
- AI becomes limited: AI Assistant features require Pro subscription
License Activation
Activating Pro
- Click the menu bar icon β Upgrade to Pro
- Complete the purchase on our secure checkout
- Enter the license key you receive via email
- Click Activateβyour Pro features unlock instantly
Managing Your License
- View status: Menu bar β About shows your current plan
- Cancel subscription: Manage through your payment provider account
- Transfer license: Contact support to move your license to a new Mac
Each Pro license is valid for one machine. Contact support if you need to change devices.
Watched Folders
Watched folders are directories that SortMeOut monitors for new or changed files.
How Monitoring Works
- SortMeOut uses macOS FSEvents for efficient, low-overhead monitoring
- New files trigger rule evaluation within seconds
- Subfolders are optionally included based on your settings
- Multiple folders can be watched simultaneously
Recommended Folders to Watch
| Folder | Use Case |
|---|---|
~/Downloads |
Auto-sort downloads by type |
~/Desktop |
Keep desktop clean |
~/Documents |
Organize documents into subfolders |
~/Pictures/Screenshots |
Manage screenshots |
Understanding Rules
Rules are the heart of SortMeOut. Each rule defines when to act (conditions) and what to do (actions).
Rule: "Organize PDFs"
βββ Conditions (IF)
β βββ Extension equals "pdf"
β βββ Size greater than "1MB"
β
βββ Actions (THEN)
β βββ Move to ~/Documents/PDFs/
β βββ Add tag "Archived"
β
βββ Options
βββ Continue processing: No
βββ Priority: 10
Rule Evaluation
- Rules are evaluated in priority order (lower number = higher priority)
- By default, processing stops after the first matching rule
- Enable "Continue processing" to allow multiple rules to match
Match Modes
| Mode | Logic | Description |
|---|---|---|
| All | AND | Every condition must match |
| Any | OR | At least one condition must match |
| None | NOT | No conditions can match |
Condition Reference
Complete list of available conditions for matching files.
File Name Conditions
| Condition | Operators | Example |
|---|---|---|
| Name | equals, contains, starts with, ends with, matches regex | Name contains "invoice" |
| Extension | equals, is in list, is not | Extension is "pdf" |
| Full Name | equals, contains, matches | Full name matches "*_backup.*" |
Size Conditions
| Condition | Operators | Example |
|---|---|---|
| Size | greater than, less than, between | Size > 10 MB |
Supported units: B, KB, MB, GB, TB
Date Conditions
| Condition | Operators | Example |
|---|---|---|
| Date Created | is today, within last, more than ago, before, after | Created within last 7 days |
| Date Modified | is today, within last, more than ago, before, after | Modified more than 30 days ago |
| Date Added | is today, within last, more than ago | Added today |
macOS Specific
| Condition | Description | Example |
|---|---|---|
| Tags | Finder tags/labels | Has tag "Important" |
| Kind | Finder file kind | Kind is "PDF Document" |
| Where From | Download source URL | Downloaded from "github.com" |
| Finder Comment | Spotlight comment | Comment contains "archive" |
Action Reference
Complete list of available actions to perform on matching files.
File Operations
| Action | Parameters | Description |
|---|---|---|
| Move to | Destination folder | Move file to specified folder |
| Copy to | Destination folder | Copy file to specified folder |
| Rename | Pattern | Rename file using variables |
| Delete | β | Move to Trash |
| Archive | Format (zip, tar, etc.) | Compress file |
macOS Actions
| Action | Parameters | Description |
|---|---|---|
| Add Tags | Tag names | Add Finder tags |
| Remove Tags | Tag names | Remove specific tags |
| Set Color Label | Color | Set Finder color label |
| Open With | Application | Open file with specific app |
| Reveal in Finder | β | Show file in Finder |
Script Actions
| Action | Parameters | Description |
|---|---|---|
| Run Shell Script | Command | Execute shell command |
| Run AppleScript | Script | Execute AppleScript |
| Run Shortcut | Shortcut name | Run a macOS Shortcut |
Variables & Patterns
Use variables in rename patterns and destinations to create dynamic paths.
Available Variables
| Variable | Description | Example Output |
|---|---|---|
{name} |
Filename without extension | document |
{ext} |
File extension | |
{date} |
Current date (YYYY-MM-DD) | 2026-02-04 |
{time} |
Current time (HH-MM-SS) | 14-30-00 |
{created} |
File creation date | 2026-01-15 |
{modified} |
File modification date | 2026-02-01 |
{year} |
Current year | 2026 |
{month} |
Current month (01-12) | 02 |
{counter} |
Auto-increment number | 001 |
{parent} |
Parent folder name | Downloads |
Pattern Examples
# Rename with date prefix
{date} - {name}.{ext}
β 2026-02-04 - document.pdf
# Organize by year/month
~/Documents/{year}/{month}/{name}.{ext}
β ~/Documents/2026/02/document.pdf
# Add counter for duplicates
{name}_{counter}.{ext}
β document_001.pdf
Keyboard Shortcuts
| Shortcut | Action |
|---|---|
| β + N | New Rule |
| β + S | Save Rule |
| β + , | Open Preferences |
| β + R | Run Rules Now |
| β + Q | Quit SortMeOut |
Configuration
SortMeOut stores configuration in ~/.config/sortmeout/
Configuration Files
| File | Purpose |
|---|---|
config.json |
Main configuration |
rules.json |
All defined rules |
sortmeout.log |
Application logs |
Settings Reference
{
"start_at_login": true,
"check_interval": 5,
"show_notifications": true,
"preview_mode": false,
"log_level": "info",
"theme": "system"
}
Command Line Interface
SortMeOut includes a CLI for advanced users and scripting.
Basic Commands
# Start the daemon
sortmeout start
# Stop the daemon
sortmeout stop
# Check status
sortmeout status
# Run rules once on a folder
sortmeout run ~/Downloads
# List all rules
sortmeout rules list
# Enable/disable a rule
sortmeout rules enable "Rule Name"
sortmeout rules disable "Rule Name"
# Process a specific file
sortmeout process /path/to/file.pdf
Troubleshooting
Common Issues
Files aren't being processed
- Verify SortMeOut is running (check menu bar icon)
- Confirm the folder is in your watched list
- Check that Full Disk Access is enabled
- Review your rule conditions
Permission denied errors
- Open System Settings β Privacy & Security
- Grant Full Disk Access to SortMeOut
- Restart SortMeOut after changing permissions
High CPU usage
- Reduce the number of watched folders
- Increase the check interval in settings
- Exclude folders with many frequent changes
Getting Logs
For debugging, check the log file:
# View recent logs
tail -f ~/.config/sortmeout/sortmeout.log
# Or open in Console.app
open -a Console ~/.config/sortmeout/sortmeout.log
Rule Examples
Ready-to-use rule templates for common scenarios.
π Organize Documents by Type
Folder: ~/Downloads
Conditions: Extension is in [pdf, doc, docx, txt]
Actions: Move to ~/Documents/{ext}/
πΌοΈ Sort Images by Date
Folder: ~/Pictures
Conditions: Kind is "Image"
Actions: Move to ~/Pictures/{year}/{month}/
ποΈ Clean Old Downloads
Folder: ~/Downloads
Conditions: Date added more than 30 days ago
Actions: Move to Trash
πΈ Process Screenshots
Folder: ~/Desktop
Conditions:
- Name starts with "Screenshot"
- Extension is "png"
Actions:
- Move to ~/Pictures/Screenshots/
- Rename to "{created} - Screenshot.png"
πΌ Tag Work Files
Folder: ~/Downloads
Conditions: Downloaded from "company.sharepoint.com"
Actions:
- Move to ~/Documents/Work/
- Add tag "Work"
Frequently Asked Questions
Does SortMeOut run at startup?
Yes, by default. You can change this in Preferences β General.
Can I undo an action?
Files moved to Trash can be recovered. For other actions, check the activity log for the original location.
How do I backup my rules?
Export rules from Preferences β Rules β Export, or copy
~/.config/sortmeout/rules.json
Can I run rules manually?
Yes! Click the menu bar icon β "Run Rules Now" or use the CLI: sortmeout run
Support
Need help? We're here for you.
Email Support
said@saidborna.com
Website
sortmeout.saidborna.com
SortMeOut v1.0.1 β’ Β© 2026 Said Borna. All rights reserved.
This documentation is proprietary. Unauthorized distribution is prohibited.