Skip to main content

A smart CLI file organizer that cleans clutter

Project description

🌳 SHELVR — File Organizer CLI

shelvr is a safe, extensible command-line tool written in Python for organizing files by type. It supports recursive operations, dry runs, logging, and CLI flags for customizable behavior. Currently adding undo , batches and many other features also so keep following


✨ Features

  • Organizes files into folders by type (e.g., Pictures, Documents, Videos, etc.)
  • Dry run mode (preview changes without moving files)
  • Recursive subdirectory processing (--recursive)
  • Verbosity control (--verbose, --quiet)
  • Console + file logging
  • Safe path checks to prevent accidental system-wide changes
  • Easily extensible (add custom file types or logic)

📦 Installation

Once published on PyPI:

pip install shelvr

Or install locally:

git clone https://github.com/your-username/tidy-tree.git
cd shelvr
pip install .

🚀 Usage

shelvr organize ~/Downloads --recursive --verbose
shelvr dry_run ~/Desktop --logfile

Available Commands

  • organize: Actually move files
  • dry_run: Preview what would happen

Options

  • --recursive: Organize subdirectories
  • --verbose / --quiet: Set log level
  • --logfile: Save logs to organize.log
  • --version: Show version info

🛠 Ongoing Development

  • Recursive support (--recursive)
  • Moved from sys.argv to argparse
  • Logging to both console and file
  • Packaged and ready for PyPI
  • Basic unit tests (planned)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

shelvr-0.1.1.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

shelvr-0.1.1-py3-none-any.whl (5.9 kB view details)

Uploaded Python 3

File details

Details for the file shelvr-0.1.1.tar.gz.

File metadata

  • Download URL: shelvr-0.1.1.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for shelvr-0.1.1.tar.gz
Algorithm Hash digest
SHA256 002a719f6423c4f788ec50a87d4b35ffad407372143df20a5d4b8b2908f5cf30
MD5 e89b9293644de67545a7c3bd2ed41da4
BLAKE2b-256 493fb5d3d885dd62bfd1b3503b11e030784491f10d9b51f18e9b4930c7a60ad8

See more details on using hashes here.

File details

Details for the file shelvr-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: shelvr-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 5.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for shelvr-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5dfbf05bee04dec610f23c97f9c648a7974240d8b4cabdb1e3ee2eddc39eb82c
MD5 22bdfb65ad39b241a7e27666baecebe4
BLAKE2b-256 69c6f9b9750edb1609598d09d11616f233e292fe492e64dcc6a0b52af579d9cc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page