mac-upkeep

Automated macOS maintenance CLI. Runs Homebrew updates, dev tool cache cleanup (gcloud, pnpm, uv), Fish plugin updates, system optimization, and Brewfile enforcement on boot + weekly via brew services — zero config required.

Install

brew install calvindotsg/tap/mac-upkeep
brew services start mac-upkeep  # runs on boot + Monday 12 PM

Or via uv:

uv tool install mac-upkeep   # persistent install
uvx mac-upkeep run            # one-off without installing

Tasks

Tasks auto-detect installed tools — missing tools are skipped. Use --force <task> to run a specific task on demand.

mac-upkeep tasks  # See all tasks with status, frequency, and next run

Usage

mac-upkeep run                       # Run tasks (frequency-checked)
mac-upkeep run --dry-run             # Preview without executing
mac-upkeep run --force brew_update   # Run only brew_update
mac-upkeep run --force all           # Run all, ignoring schedule
mac-upkeep run --debug               # Verbose output
mac-upkeep tasks                     # List tasks with status and next run
mac-upkeep init                      # Generate config (detects your tools)
mac-upkeep show-config --default     # Show all available task options
mac-upkeep show-config               # Show your config overrides
mac-upkeep setup                     # Print sudoers rules
mac-upkeep status                    # Show scheduling dashboard
mac-upkeep logs                      # View last 20 log lines
mac-upkeep logs -f                   # Follow logs
mac-upkeep --version                 # Show version

Configuration

Works out of the box with zero configuration. To customize, generate a starter config:

mac-upkeep init

This probes your system, detects installed tools, and writes a commented config to ~/.config/mac-upkeep/config.toml. Only detected tasks are listed. Built-in defaults apply automatically — uncomment lines to override.

To see all available tasks and options:

mac-upkeep show-config --default

Override examples

# ~/.config/mac-upkeep/config.toml

# Disable a task
[tasks.gcloud]
enabled = false

# Change frequency (daily, weekly, or monthly)
[tasks.brew_update]
frequency = "monthly"

# Set Brewfile path explicitly
[paths]
brewfile = "~/.config/Brewfile"

Task fields are type-checked. TOML booleans are unquoted — enabled = false, not enabled = "false" — and a quoted one is now rejected with an error rather than silently leaving the task enabled. Task names are matched case- and space-insensitively ([tasks.Docker Prune] and [tasks.docker_prune] are the same task, and declaring both is an error).

Brewfile discovery

With no [paths] brewfile and no MAC_UPKEEP_BREWFILE/HOMEBREW_BUNDLE_FILE, only two absolute locations are searched: $XDG_CONFIG_HOME/Brewfile (default ~/.config/Brewfile) and ~/.Brewfile. The current working directory is deliberately not searched. brew bundle evaluates a Brewfile as Ruby and brew_bundle runs cleanup --force, so a CWD-relative lookup made whichever project directory your shell happened to be in able to run code and uninstall every package it did not list. If no Brewfile is found the task skips; it no longer runs with an empty --file=, which Homebrew resolved back to $PWD/Brewfile.

Custom tasks

Add your own tasks using the same format:

[tasks.docker_prune]
description = "Prune Docker system"
command = "docker system prune -f"
detect = "docker"
frequency = "monthly"

# Control execution order
[run]
order = ["brew_update", "brew_upgrade", "docker_prune", "brew_cleanup", "brew_bundle"]

git_sync

Pull configured git repositories daily with git pull --ff-only. Opt-in — list your repos explicitly:

[git_sync]
repos = [
    "~/code/my-project",
    "~/work/max-*",       # glob patterns supported
]
skip_dirty = true         # skip repos with uncommitted changes

Each repo is skipped with a reason if it's not a git repo, has no remote, has no upstream branch, or (when skip_dirty = true) has uncommitted changes.

Only enrol repositories you created

A git repository's own .git/config can make git execute commands. Point a repos glob only at directories you created yourself — never at a downloads, sync, backup, or vendor-drop directory. A tree that arrives by archive, restore, or file sync brings its .git/config and .git/hooks with it, and safe.directory does not help: it keys on ownership, and anything you unpacked is owned by you. A plain git clone does not carry these, so cloning is unaffected.

mac-upkeep neutralises the directives it can, on every git call — not just on pull, because git status --porcelain (the skip_dirty check itself) is enough to trigger some of them:

Note the asymmetry in the middle two rows. credential.helper is multi-valued, so an empty entry resets git's accumulated list. core.sshCommand is single-valued, so an empty entry is not a reset — git would try to execute the empty string and every SSH remote would fail. Single-valued keys are therefore set, never blanked.

Three consequences worth knowing:

• Local-path remotes no longer work under git_sync (fatal: transport 'file' not allowed). This is deliberate — it is what closes the uploadpack execution path. Pull from a bare mirror on an external disk outside mac-upkeep.
• git:// remotes no longer work (fatal: transport 'git' not allowed). Also deliberate: core.gitProxy runs an arbitrary command for that transport and cannot be neutralised any other way. git:// is unauthenticated and unencrypted; use SSH or HTTPS.
• Repository hooks do not run during git_sync, so a post-merge hook that installs dependencies will not fire on an unattended pull.

This is defence in depth, not a sandbox. Git has no "ignore this repository's config" switch. The known remaining execution path is filter.<driver>.clean from a planted .gitattributes, which fires on git status: driver names are arbitrary, so no fixed override covers them. Enrolment discipline is the control that actually holds.

Authentication

Any of the following work under launchd without mac-upkeep-side configuration:

• SSH + IdentityAgent (recommended under launchd): a path-based entry in ~/.ssh/config pointing at any SSH agent's UNIX socket. Works because the directive is a file path, not the SSH_AUTH_SOCK env var that launchd would strip.
• HTTPS + credential helper: gh auth setup-git or git config --global credential.helper osxkeychain. Requires the helper binary on the launchd PATH.
• [url].insteadOf rewrite: force SSH regardless of remote protocol by rewriting https://<host>/ in ~/.gitconfig to a matching SSH Host alias. Bypasses HTTPS auth entirely.

git_sync sets GIT_TERMINAL_PROMPT=0 and a no-op GIT_ASKPASS default (user-set GIT_ASKPASS is respected) so misconfigured auth fails in milliseconds instead of stalling to the 60 s subprocess timeout.

Environment variables

MAC_UPKEEP_GCLOUD=false mac-upkeep run              # Disable a task
MAC_UPKEEP_GCLOUD_FREQUENCY=monthly mac-upkeep run  # Override frequency

MAC_UPKEEP_<TASK> enables the task only for an explicitly truthy value — true, 1, yes, or on. Anything else disables it, including off, disabled and the empty string, which previously all enabled the task by falling through a denylist of false/0/no.

Sudoers

mo_clean and mo_optimize require passwordless sudo for the mo binary:

mac-upkeep setup > /tmp/mac-upkeep.sudoers
sudo visudo -cf /tmp/mac-upkeep.sudoers    # must print "parsed OK" before installing
sudo install -m 0440 -o root -g wheel /tmp/mac-upkeep.sudoers /etc/sudoers.d/mac-upkeep

Validate before installing — a malformed file in /etc/sudoers.d/ can lock you out of sudo.

⚠ Upgrading from < 3.0.0 — action required

The sudoers file is installed manually, so brew upgrade does not update it. Reinstall it using the commands above.

Releases before 3.0.0 generated env_keep += "HOME". Sudo preserves HOME but still resets USER to root, and mole compares $HOME's owner against $USER to decide whether your home directory needs a permissions repair. The mismatch makes it run diskutil resetUserPermissions / $(id -u) — and under sudo id -u is 0, so it attempts to reset your home directory to root's uid. The call fails, which is the only reason this is noisy rather than destructive, but it also makes mo optimize exit non-zero on every run.

3.0.0 generates env_keep += "HOME USER LOGNAME". Verify with sudo -n $(brew --prefix)/bin/mo optimize </dev/null >/dev/null; echo $? — it should print 0.

Log file permissions

mac-upkeep setup now prints the newsyslog.d line with mode 640 instead of 644. The log records git_sync failures by repository name, which enumerates your private and employer-internal repositories, and $(brew --prefix)/var/log is world-traversable — unlike ~/Library, nothing else gates it. Owner plus the admin group keeps mac-upkeep logs working.

⚠ Already installed? Like the sudoers file, /etc/newsyslog.d/mac-upkeep.conf is not upgraded by brew upgrade, and existing log files keep their 644 mode. Rewrite the conf from mac-upkeep setup, then:

sudo chmod 640 "$(brew --prefix)"/var/log/mac-upkeep.log*

Contributing

See CONTRIBUTING.md for development setup and conventions.

License

MIT