dorgy 0.4.4

AI-assisted CLI for organizing files.

Dorgy

AI‑assisted CLI to keep growing collections of files tidy. Organize folders with safe renames/moves and undo, watch directories for changes, and search collections with substring or semantic queries — all powered by portable per‑collection state.

---

Installation

PyPI (recommended)

pip install dorgy

From source (contributors)

git clone https://github.com/bryaneburr/dorgy.git
cd dorgy

# Optional: install dev dependencies
uv sync --extra dev

# Optional: editable install
uv pip install -e .

---

Getting Started

# Inspect available commands
dorgy --help

# Organize a directory in place (dry run first)
dorgy org ./documents --dry-run
dorgy org ./documents

# Monitor a directory and emit JSON batches
dorgy watch ./inbox --json --once

# Undo the latest plan
dorgy undo ./documents --dry-run
dorgy status ./documents --json

See the docs for guides on Organize, Watch, Search, Move/Undo, and configuration details.

---

Documentation

• Published site: https://bryaneburr.github.io/dorgy/
• Source: docs/ (MkDocs + shadcn)
• Start with Getting Started → Quickstart and Configuration.

Contributing

We welcome issues and pull requests. See docs/development/contributing.md for environment setup, pre‑commit hooks, and CI guidance.

Authors

• Codex (ChatGPT‑5 based agent) — primary implementation and tactical design.
• Bryan E. Burr (@bryaneburr) — supervisor, editor, and maintainer.

License

Released under the MIT License. See LICENSE for details.