rangler 0.1.0__tar.gz

rangler-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,83 @@
+# Publishes rangler to PyPI when a GitHub release is published.
+#
+# Uses PyPI trusted publishing (OIDC), so no API token is stored: the workflow
+# exchanges a short-lived GitHub identity token for an upload token. This
+# requires a trusted publisher to be configured on PyPI for the project (see
+# below) and the `pypi` environment to exist on the repository.
+#
+# PyPI trusted publisher configuration (one-time, on pypi.org):
+#   - Project: rangler
+#   - Owner: johngrimes
+#   - Repository: rangler
+#   - Workflow: publish.yml
+#   - Environment: pypi
+#
+# Author: John Grimes.
+
+name: Publish
+
+on:
+  release:
+    types: [published]
+  # Allow a manual publish from the Actions tab or `gh workflow run`. Dispatch
+  # against a version tag (for example `v0.1.0`) so the verify step below can
+  # confirm the ref matches the packaged version.
+  workflow_dispatch:
+
+jobs:
+  publish:
+    name: Build and publish to PyPI
+    runs-on: ubuntu-latest
+
+    # Scope the OIDC credential to a dedicated environment so the publish step
+    # can be gated with required reviewers or branch rules if desired.
+    environment:
+      name: pypi
+      url: https://pypi.org/project/rangler/
+
+    permissions:
+      # Required for trusted publishing to mint the OIDC token.
+      id-token: write
+      contents: read
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v7
+
+      - name: Install uv
+        # Pin to a full version tag: from v8.0.0 onwards setup-uv publishes
+        # immutable, full-version tags only and no longer moves a `v8` major
+        # tag, so `@v8` cannot be resolved.
+        uses: astral-sh/setup-uv@v8.2.0
+
+      - name: Install Python
+        run: uv python install
+
+      # Guard against publishing a mismatched version: PyPI uploads are
+      # irreversible (a version can never be re-uploaded), so a tag that does
+      # not match the packaged version must abort before anything is built.
+      - name: Verify tag matches package version
+        # For a release event the tag comes from the release payload; for a
+        # manual dispatch it comes from the ref the workflow was run against, so
+        # a dispatch must target a version tag rather than a branch.
+        env:
+          TAG: ${{ github.event.release.tag_name || github.ref_name }}
+        run: |
+          version="$(python3 -c "import tomllib; print(tomllib.load(open('pyproject.toml', 'rb'))['project']['version'])")"
+          tag="${TAG#v}"
+          if [ "$tag" != "$version" ]; then
+            echo "::error::Tag '${TAG}' does not match pyproject version '${version}'."
+            exit 1
+          fi
+          echo "Tag '${TAG}' matches package version '${version}'."
+
+      - name: Build
+        run: uv build
+
+      # Confirm the freshly built wheel installs and its entry point runs before
+      # anything is uploaded, catching missing files or a broken console script.
+      - name: Smoke test (wheel)
+        run: uv run --isolated --no-project --with dist/*.whl -- rangler --version
+
+      - name: Publish
+        run: uv publish

rangler-0.1.0/.gitignore

@@ -0,0 +1,19 @@
+# Python bytecode and caches.
+__pycache__/
+*.py[cod]
+
+# Virtual environments.
+.venv/
+
+# Test and coverage artifacts.
+.coverage
+.pytest_cache/
+htmlcov/
+
+# Linter caches.
+.ruff_cache/
+
+# Build outputs.
+dist/
+build/
+*.egg-info/

rangler-0.1.0/CLAUDE.md

@@ -0,0 +1,126 @@
+# rangler
+
+rangler is a macOS command-line tool that backs up a single user's home
+directory to an rclone remote: an explicit list of configured paths (under
+`files/`) and auto-discovered project `.local` directories (under `locals/`),
+namespaced by hostname, with versioned deletes and optional scheduling.
+
+## Constitution
+
+### Core Principles
+
+#### I. Data safety is non-negotiable
+
+rangler is trusted with the only copy of a user's data, so an accidental local
+write or an unrecoverable remote delete is the worst possible failure.
+
+- Backups are one-way (local to remote). rangler MUST NOT write to the local
+  filesystem except its own config (`~/.config/rangler/`), logs
+  (`~/Library/Logs/rangler/`), runtime state and lock
+  (`~/.local/state/rangler/`), and its LaunchAgent plist
+  (`~/Library/LaunchAgents/au.id.grimes.john.rangler.plist`).
+- rangler MUST NOT hard-delete remote data. Prior copies of files that are
+  changed or removed locally MUST be moved into the timestamped
+  `_versions/<run-timestamp>/` area before being overwritten.
+- rangler MUST only ever write under `<base>/<host>/`; other hosts' trees MUST
+  remain untouched.
+- Every configured path and scan root MUST resolve (after `~` expansion) to a
+  location under `$HOME`. A non-home entry is a hard configuration error and is
+  never backed up.
+
+#### II. Fail safe, fail loud
+
+A backup tool earns trust by never failing silently and never half-doing the
+job.
+
+- A run MUST verify that rclone is available and the configured remote is
+  reachable before transferring anything; otherwise it aborts before making any
+  change, prints actionable guidance, and exits non-zero.
+- Targets MUST be processed independently: a per-target failure is recorded and
+  the run continues with the remaining targets; any failed target makes the run
+  exit non-zero.
+- Overlapping runs MUST be prevented by a lock. A second concurrent run exits
+  cleanly and records that it was skipped, never interleaving writes to the
+  remote.
+- The user MUST be kept informed of system status: per-target start and finish,
+  a final run summary, a written per-run log, desktop notifications per the
+  configured policy, and a `status` command reporting schedule state and the
+  last run's result. Silent success and silent failure are both defects.
+
+#### III. The remote layout is a stable contract
+
+Restore is performed manually against the structure rangler writes, so that
+structure is a public contract, not an implementation detail.
+
+- The destination layout MUST remain stable: hostname namespacing; the `files/`,
+  `locals/`, and `_versions/<timestamp>/` sections; and the home-relative
+  mapping rules that place each source under them.
+- `_versions/` MUST remain a sibling of `files/` and `locals/`, never nested
+  inside a destination, to satisfy rclone's `--backup-dir` constraint.
+- Any change that breaks restore compatibility with data already on a remote
+  MUST be treated as a breaking change: called out explicitly and documented,
+  never shipped silently.
+
+#### IV. Radical simplicity, minimal dependencies
+
+Complexity is a cost that must be justified; the simplest design that meets the
+requirement wins.
+
+- Click is the only permitted runtime dependency. Everything else MUST come from
+  the Python standard library, and rangler MUST shell out to the user-installed
+  rclone binary rather than embedding rclone as a library.
+- Introducing a new runtime dependency, a daemon, a database, or a built-in
+  encryption layer is prohibited unless it is justified against a simpler
+  alternative and explicitly agreed.
+- When multiple approaches work, choose the one with the fewest moving parts;
+  aggressively remove abstractions that are not strictly necessary.
+
+#### V. Pure functions, tested first
+
+The logic must be testable without touching the network, the filesystem, or
+launchd.
+
+- Test-driven development is mandatory: write failing tests that define the
+  behaviour, add minimal stubs, confirm the tests fail for the right reason,
+  then implement until they pass.
+- All behaviour MUST live in standalone functions operating on immutable
+  (frozen dataclass) data shapes; behavioural classes are not used. Side effects
+  - subprocess, filesystem, `launchctl`, `osascript` - MUST be confined to thin
+  wrappers and the CLI layer.
+- Unit tests MUST mock the rclone subprocess and exercise every branch. A small
+  set of integration tests run the real rclone binary against a local-path
+  remote and are skipped when rclone is absent.
+
+### Additional constraints
+
+- **Platform and scope**: macOS, single user. Scheduling uses launchd
+  LaunchAgents; cross-platform scheduling is out of scope. Restore is out of
+  scope as a command - it is documented as manual rclone steps against the
+  remote layout.
+- **Configuration**: a single TOML file at `~/.config/rangler/config.toml`,
+  validated with clear errors. Unknown keys are reported as warnings (typo
+  protection) rather than aborting.
+- **Trust boundaries**: rclone installation, remote configuration, and any
+  encryption (for example an rclone crypt remote) are the user's
+  responsibility. rangler validates these but never installs or configures
+  rclone and adds no encryption of its own.
+- **Symlinks**: rangler follows symlinks so that symlinked dotfiles are stored
+  as content rather than dangling link references; excludes are the mechanism
+  for preventing unwanted bulk.
+
+### Development workflow and quality gates
+
+- **Tooling**: uv manages the project, its Python version, and its virtual
+  environment. ruff lints and formats. Python files use snake_case (the
+  lowerCamelCase file-naming rule is TypeScript-only).
+- **Documentation**: every public function carries a complete docstring -
+  purpose, parameters, return value, exceptions, and an example for non-trivial
+  functions. New source files are authored by John Grimes.
+- **Definition of done**: the full pytest suite, `ruff check`, and
+  `ruff format --check` MUST pass, and the change MUST be demonstrated to work
+  (for example via a dry run against a local-path remote) before it is called
+  complete.
+- **Reviewability**: every change MUST be checkable against these principles. A
+  reviewer should be able to point to the principle a change violates without
+  ambiguity. An unavoidable violation MUST be documented and agreed, never
+  slipped in.

rangler-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

rangler-0.1.0/NOTICE

@@ -0,0 +1,8 @@
+rangler
+
+Copyright © 2026 John Grimes.
+
+This product is licensed under the Apache License, Version 2.0 (the "License");
+you may not use this product except in compliance with the License. A copy of
+the License is provided in the LICENSE file accompanying this product, and is
+also available at http://www.apache.org/licenses/LICENSE-2.0.

rangler-0.1.0/PKG-INFO

@@ -0,0 +1,222 @@
+Metadata-Version: 2.4
+Name: rangler
+Version: 0.1.0
+Summary: macOS home-directory backup to an rclone remote, with versioning and scheduling.
+Author: John Grimes
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Requires-Python: >=3.13
+Requires-Dist: click==8.4.1
+Description-Content-Type: text/markdown
+
+# rangler
+
+rangler is a macOS command-line tool that backs up a single user's home
+directory to an [rclone](https://rclone.org/) remote. It mirrors an explicit
+list of configured paths (under `files/`) and auto-discovered project `.local`
+directories (under `locals/`), namespaces everything by hostname, keeps prior
+versions of changed and deleted files, and can run unattended on a schedule.
+
+Backups are one-way (local to remote). rangler never writes to your local
+filesystem except its own configuration, logs, runtime state, and its
+LaunchAgent. It shells out to the `rclone` binary you have installed; it does not
+install or configure rclone, and it adds no encryption of its own (use an rclone
+crypt remote if you want that).
+
+## Requirements
+
+- macOS, single user.
+- [rclone](https://rclone.org/) installed and at least one remote configured.
+- Python 3.13+ and [uv](https://docs.astral.sh/uv/) for installation from source.
+
+## Installation
+
+```console
+brew install rclone
+rclone config          # create a remote, e.g. a `local` remote named `backup`
+uv tool install --editable .   # or run ad hoc with: uv run rangler ...
+```
+
+## Configuration
+
+rangler reads a single TOML file at `~/.config/rangler/config.toml`. Scaffold a
+starter file with `rangler init`, then edit it. Every path must live under your
+home directory.
+
+| Key           | Type            | Default      | Notes                                                     |
+| ------------- | --------------- | ------------ | --------------------------------------------------------- |
+| `remote_base` | string          | (required)   | rclone remote in `name:path` form, e.g. `backup:rangler`. |
+| `paths`       | array of string | `[]`         | Explicit paths under `$HOME` to back up. `~` is expanded. |
+| `scan_roots`  | array of string | `["~/Code"]` | Roots scanned for `.local` directories.                   |
+| `max_depth`   | integer         | `4`          | Maximum descent depth under each scan root.               |
+| `excludes`    | array of string | see below    | rclone filter patterns applied to every target.           |
+| `interval`    | string          | `"6h"`       | Schedule cadence as a duration: `30m`, `6h`, `1d`.        |
+| `notify`      | string          | `"failure"`  | Desktop notifications: `failure`, `always`, or `never`.   |
+
+Default `excludes`: `node_modules/**`, `.git/**`, `.DS_Store`, `*.log`,
+`.cache/**`, `__pycache__/**`. At least one of `paths` or `scan_roots` must be
+non-empty. Unknown keys are reported as warnings (typo protection) rather than
+aborting.
+
+## Usage
+
+### `rangler init`
+
+Scaffold a starter `config.toml`. Does nothing if one already exists unless you
+pass `--force` to overwrite it.
+
+```console
+rangler init
+```
+
+### `rangler check`
+
+Validate the configuration, confirm rclone is present and the remote is
+reachable, and print the full resolved target list (each source and its computed
+destination) without transferring anything. Exits `0` when valid, `2` when the
+configuration is invalid, and `3` when rclone is missing or the remote is
+unreachable.
+
+```console
+rangler check
+```
+
+### `rangler run`
+
+Back up every resolved target. Each explicit path is mirrored to
+`<remote_base>/<hostname>/files/<path-relative-to-home>`. Symlinks are followed
+so symlinked dotfiles are stored as content. Prior copies of changed or deleted
+files are moved into `<remote_base>/<hostname>/_versions/<run-timestamp>/...`
+rather than being hard-deleted. Each run prints per-target progress and a final
+summary, and writes a timestamped log to `~/Library/Logs/rangler/`.
+
+```console
+rangler run            # perform the backup
+rangler run --dry-run  # report intended changes without writing to the remote
+```
+
+A configured path that does not exist on this machine is reported as skipped and
+does not fail the run (paths legitimately differ across machines). A path that
+exists but errors during transfer is recorded as a failed target; the run
+continues with the others and exits non-zero. Overlapping runs are prevented by a
+lock: a second concurrent run exits cleanly with `skipped: already running`.
+
+### Auto-discovery of `.local` directories
+
+Beyond the explicit `paths` list, rangler scans each entry in `scan_roots`
+(default `~/Code`) for project `.local` directories down to `max_depth` (default
+4). Each discovered `<root>/.../project/.local` is mirrored to
+`<remote_base>/<hostname>/locals/<project-path-relative-to-home>` - the `.local`
+segment itself is dropped. For example, `~/Code/pathling/.local` is backed up to
+`locals/Code/pathling`.
+
+Discovery deliberately skips:
+
+- the XDG `~/.local` directory (it shares the name but is not a project scratch
+  directory);
+- `.Trash` and any directory named by an exclude pattern (such as `node_modules`
+  or `.git`), which are pruned without being descended into.
+
+If the same directory is both discovered and listed explicitly in `paths`, it is
+backed up once, with the explicit `files/` mapping taking precedence. Run
+`rangler check` to preview the full resolved target list - explicit and
+discovered alike - before backing up.
+
+### Scheduling (`schedule` / `unschedule` / `status`)
+
+rangler can run unattended via a macOS LaunchAgent that fires on a fixed
+interval and survives reboot.
+
+```console
+rangler schedule --every 30m   # install and load the agent (defaults to config interval)
+rangler status                 # report whether scheduling is active and the last run
+rangler unschedule             # unload and remove the agent
+```
+
+`schedule` writes a LaunchAgent plist to
+`~/Library/LaunchAgents/au.id.grimes.john.rangler.plist` and loads it with `launchctl
+bootstrap`; re-running it replaces any existing agent. `--every` accepts a
+duration (`30m`, `6h`, `1d`) and defaults to the `interval` from the config.
+`unschedule` is idempotent: it succeeds even if nothing was installed. `status`
+reports the active interval and the time and result of the last run (read from
+`~/.local/state/rangler/last-run.json`).
+
+You can confirm the loaded job directly with launchctl:
+
+```console
+launchctl print gui/$(id -u)/au.id.grimes.john.rangler
+```
+
+### Notifications
+
+For unattended runs, rangler can raise a macOS desktop notification at run
+completion. The `notify` config key controls when:
+
+- `failure` (default): notify only when one or more targets failed.
+- `always`: notify on every completed run, success or failure.
+- `never`: stay silent.
+
+Notifications fire for real runs (manual or scheduled); a `--dry-run` preview is
+always silent.
+
+## Remote layout
+
+Given `remote_base = "backup:rangler"` and hostname `mymac`:
+
+```text
+backup:rangler/
+└── mymac/                         # Hostname segment.
+    ├── files/                     # Explicit configured paths.
+    │   ├── .ssh/...               # from ~/.ssh
+    │   └── Documents/notes/...    # from ~/Documents/notes
+    ├── locals/                    # Auto-discovered .local directories.
+    │   └── Code/pathling/...      # from ~/Code/pathling/.local
+    └── _versions/                 # Versioned overwrites/deletes.
+        └── 2026-06-19T03-21-55Z/  # One sub-tree per run that changed something.
+            ├── files/...
+            └── locals/...
+```
+
+This layout is a stable contract that manual restore relies on. rangler only
+ever writes under `<remote_base>/<hostname>/`, so other machines' trees are never
+touched.
+
+## Restore (manual)
+
+Restore is performed manually with rclone against the layout above. For example:
+
+```console
+rclone copy backup:rangler/mymac/files/.ssh ~/.ssh
+rclone copy backup:rangler/mymac/locals/Code/pathling ~/Code/pathling/.local
+```
+
+Earlier versions of a file are found under
+`backup:rangler/mymac/_versions/<timestamp>/...`.
+
+## Troubleshooting
+
+- **"rclone is not installed or not on your PATH"** - install rclone
+  (`brew install rclone`) and confirm `rclone version` works in your shell.
+- **"the remote ... is not reachable"** - the name before the `:` in
+  `remote_base` must match a remote from `rclone listremotes`. Create or rename
+  it with `rclone config`.
+- **A configured path is reported as skipped** - the path does not exist on this
+  machine. This is expected when paths differ across machines; it does not fail
+  the run.
+- **A target is reported as failed** - check the per-run log under
+  `~/Library/Logs/rangler/` for the rclone error (for example a permission
+  problem). The run still backs up every other target and exits non-zero.
+- **"skipped: already running"** - another rangler run holds the lock at
+  `~/.local/state/rangler/rangler.lock`. Wait for it to finish; the lock is
+  released automatically even if that process is killed.
+- **Scheduled runs are not happening** - confirm the agent is loaded with
+  `launchctl print gui/$(id -u)/au.id.grimes.john.rangler` and inspect
+  `~/Library/Logs/rangler/launchd.err.log`.
+
+## Licence
+
+rangler is licensed under the [Apache License, Version 2.0](LICENSE). See the
+[NOTICE](NOTICE) file for attribution.
+
+Copyright © 2026 John Grimes.