Compare commits

..
1 Commits
Author SHA1 Message Date
sneak e5a83cb190 Bring README and TODO.md in line with next after the milestone merge (closes #132)
check / check (push) Successful in 1m24s
Docs only. TODO.md's Next Step says no implementation work is open and
the cache design waits on sneak's review. The README is corrected
wherever the code contradicts it: login's TOTP and email OTP steps and
the crypto done outside libsodium; which errors are retried and what
each backup does with a failed download; which metadata a backup's JSON
keeps; the session and logout behavior; the CLI's --exif, --json, ML
data and thumbnail-fixer details; the cache's default directory and
size limit; when refreshes run and what fresh() and lib.backup() wait
for; the Photo fields; test coverage; the Makefile shims; and the
408/429 retries.

Model: opus-5-5
2026-09-29 02:53:07 +00:00
2 changed files with 7 additions and 7 deletions
+4 -3
View File
@@ -10,9 +10,10 @@ account into a deduplicated local directory tree, skipping files that already
exist on disk and continuing past individual download failures instead of exist on disk and continuing past individual download failures instead of
crashing. For each file it persists the basic metadata fields quak keeps (title, crashing. For each file it persists the basic metadata fields quak keeps (title,
file type, creation and modification time, latitude, longitude, content hash), file type, creation and modification time, latitude, longitude, content hash),
and the private and public magic metadata in full. A helper subcommand can and the private and public magic metadata in full, including camera info, GPS
detect and regenerate missing thumbnails, encrypting and uploading them back to coordinates, captions, and any face/keyword labels the Ente clients have added.
the server. A helper subcommand can detect and regenerate missing thumbnails, encrypting and
uploading them back to the server.
## Getting Started ## Getting Started
+3 -4
View File
@@ -42,10 +42,9 @@ declares one.
IPTC; which commands take `--json`; a failed ML data request may not have been IPTC; which commands take `--json`; a failed ML data request may not have been
retried; the thumbnail fixer is not limited to baseline JPEG; `quak backup` retried; the thumbnail fixer is not limited to baseline JPEG; `quak backup`
still fetches ML data; a backup's JSON holds the basic metadata fields quak still fetches ML data; a backup's JSON holds the basic metadata fields quak
keeps and the private and public magic metadata, not every decrypted field, keeps and the private and public magic metadata, not every decrypted field;
and the README no longer lists what the magic metadata holds; the default the default cache directory is the per-user one, not an XDG path on macOS;
cache directory is the per-user one, not an XDG path on macOS; pinned pinned originals can exceed `cacheOriginalsMaxBytes`; which tests cover which
originals can exceed `cacheOriginalsMaxBytes`; which tests cover which
operations; a default read is only as current as the last refresh whose operations; a default read is only as current as the last refresh whose
requests all succeeded; `fresh()` and `lib.backup()` join a refresh already requests all succeeded; `fresh()` and `lib.backup()` join a refresh already
running; a `Photo` has no `thumbnailPath` or `originalPath`; and `408` and running; a `Photo` has no `thumbnailPath` or `originalPath`; and `408` and