Quick Start

1. Install

2. Verify installation

Verify autotidy is installed and running.

❯ autotidy status
status      🟢 running
config      ~/.config/autotidy/config.yaml
watching    none
rules
  ⚠ none

3. Create your first rule

Edit ~/.config/autotidy/config.yaml:

rules:
  - name: Organize PDFs
    locations: ~/Downloads
    filters:
      - extension: pdf
    actions:
      - move: ~/Documents/PDFs

4. Dry run your rule

Use autotidy run to preview what your rules would do without making changes:

❯ autotidy run
Dry-run mode enabled (pass --dry-run=false to perform a one-off run of all rules)

━━━ Rule: Clean up Desktop images ━━━
~/Downloads/document.pdf
├── filters:
│   └── extension:     ✓
└── actions:
    └── move:          ✓ → ~/Documents/PDFs

5. Reload your rules

Tell the daemon to pick up your config changes:

❯ autotidy reload
Reloaded ~/.config/autotidy/config.yaml

Then verify your rule is active:

❯ autotidy status
status      🟢 running
config      ~/.config/autotidy/config.yaml
watching    1 directories
rules
  🟢 Organize PDFs
    last run: 1 hour ago (2ms, 1 files)

Your rule is now running. Any PDFs added to ~/Downloads will be moved to ~/Documents/PDFs.

Next steps

Configuration - Full configuration reference
Filters - All available filters
Actions - All available actions

Keyboard shortcuts