macos-junk-cleaner 1.0.0

A utility to list and clear junk files created by macOS indexation.

macOS Junk Cleaner

A Python-based CLI utility to scan and remove macOS-specific junk files (e.g., .DS_Store, ._*, .Spotlight-V100) from directories.

Installation

Using pip

pip install .

Using uv

uv tool install .

Usage

Scan

To see what would be cleaned with a detailed summary:

mac-clean scan /path/to/dir
# or using uv
uv run mac-clean scan /path/to/dir

Clean

The clean command is used for removal. For safety, it defaults to dry-run mode.

# Preview deletion (Dry-run)
mac-clean clean /path/to/dir

# Perform actual deletion
mac-clean clean /path/to/dir --force

Development

Setup (uv)

1. Clone the repository.
2. Sync the environment (creates venv and installs all dependencies and dev tools):

   uv sync
   

3. Install pre-commit hooks:

   uv run pre-commit install
   

Linting and Formatting

This project uses Ruff for linting and formatting.

# Lint
ruff check .
# or using uv
uv run ruff check .

# Format
ruff format .
# or using uv
uv run ruff format .

Testing

pytest
# or using uv
uv run pytest

License

This project is licensed under the MIT License - see the LICENSE file for details.