Is this a backup service?
It is a local backup workflow, not a hosted backup service. The project helps you run, schedule, and inspect exports on your own Mac.
The short answers people usually need before they star or clone.
This page is for the "what is it really?" moment. Each answer is intentionally direct so you can quickly decide whether the repository fits your workflow.
Quick answers
Start with the short answer before you dive deeper.
Does it replace upstream notes-exporter?
No. It wraps upstream with a repo-owned operations layer so recurring snapshots are safer and easier to understand.
Can it sync changes back into Apple Notes?
No. This repository is for snapshotting and exporting, not two-way sync.
Do I need the Web console?
No. `notesctl` is the supported human entrypoint. The Web console is optional, local, and useful when you want a control-room view.
What is the difference between the Local Web API and MCP?
The Local Web API comes from ./notesctl web
and is a token-gated same-machine browser and HTTP surface. The
MCP Provider comes from ./notesctl mcp and is a
stdio-first host-to-tooling contract for MCP-aware agents. Neither one is a public
OpenAPI or hosted control plane.
Where are snapshots written by default?
The runtime config lives in config/notes_snapshot.env. If you keep the
defaults, snapshots are written to $HOME/iCloudDrive/NotesSnapshots.
Uncomment NOTES_SNAPSHOT_ROOT_DIR before the first run if you want a
different destination.
Why are there lock files and state files?
They are the workflow's dashboard instruments. Think of them like a flight recorder: they tell you what happened, whether the last run succeeded, and whether another run is already in progress.
What happens if the checkout path changes?
Reinstall the scheduler so the path-aware launchd surface points at the new checkout. Rebuild the local environment too if you use the repo-owned verification gates or the optional Web console.
./notesctl install --minutes 30 --load
./notesctl rebuild-dev-envCan I expose the Web console remotely?
The project is designed to stay local-first. If you deliberately bind it beyond loopback, set a strong token, review the action allowlist, and read the security summary first.
Still not answered?
Use the public Q&A discussion if your real question is setup, permission prompts, or scheduler troubleshooting.
Need the next route, not another answer?
- Compare if you are still deciding between upstream and the wrapper
- Support routing if you want the right help lane before posting
- Community if you want ideas, show-and-tell, or announcements
- Release history if you want the tag-by-tag public story
- Share kit if you want the short public explanation assets