Skip to content
ordr

Getting Started

Installation

Terminal window
brew tap McMuellermilch/tap
brew install ordr

Verify the installation:

Terminal window
ordr --version

Quick Start

  1. Create a config file

    Terminal window
    ordr init --template

    This creates ~/.ordrrc with a few starter rules (PDFs, images, archives). Open it in your editor to customize — it’s plain YAML.

  2. Preview what would be moved

    Terminal window
    ordr preview ~/Desktop

    ordr shows every file that matches a rule and where it would go. Nothing is moved yet.

  3. Run the clean

    Terminal window
    ordr clean ~/Desktop

    ordr shows the plan again and asks for confirmation before moving anything.

  4. Made a mistake? Undo it

    Terminal window
    ordr undo

    Every clean operation is logged. ordr undo reverses the last one.

Your first .ordrrc

The config file lives at ~/.ordrrc (global) or .ordrrc in any directory (local). It’s YAML and looks like this:

version: 1


rules:
  - name: "PDFs to documents"
    target: "documents"
    match:
      extensions: [".pdf"]


  - name: "Screenshots"
    target: "~/Pictures/Screenshots"
    match:
      pattern: "^Screenshot.*"
      extensions: [".png", ".jpg"]
    scope:
      dirs: ["~/Desktop"]


  - name: "Old large videos"
    target: "~/Archive/Videos"
    match:
      extensions: [".mp4", ".mov", ".mkv"]
      min_size: "500MB"
      older_than: "90d"

See Configuration for the full reference.

What’s next?