Compare commits

..
1 Commits
Author SHA1 Message Date
sneak 3ae49bd477 Bring README and TODO.md in line with next after the milestone merge (closes #132)
check / check (push) Successful in 1m40s
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; 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:40:19 +00:00
2 changed files with 16 additions and 20 deletions
+10 -12
View File
@@ -8,12 +8,11 @@ and downloads individual images while decrypting them on the way to disk.
quak also includes a resilient backup command that downloads every file in the quak also includes a resilient backup command that downloads every file in the
account into a deduplicated local directory tree, skipping files that already 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. It decrypts and persists all three metadata layers (basic, private
file type, creation and modification time, latitude, longitude, content hash), magic, public magic) per file, including camera info, GPS coordinates, captions,
and the private and public magic metadata in full, including camera info, GPS and any face/keyword labels the Ente clients have added. A helper subcommand can
coordinates, captions, and any face/keyword labels the Ente clients have added. detect and regenerate missing thumbnails, encrypting and uploading them back to
A helper subcommand can detect and regenerate missing thumbnails, encrypting and the server.
uploading them back to the server.
## Getting Started ## Getting Started
@@ -221,7 +220,7 @@ quak/
and search, request pools and search, request pools
backup.ts resilient full-account backup with dedup backup.ts resilient full-account backup with dedup
metadata-backup.ts metadata-backup.ts
backup-metadata: the metadata quak keeps, as JSON backup-metadata: all decrypted metadata as JSON
mldata-fetch.ts fetch + decrypt per-file ML data mldata-fetch.ts fetch + decrypt per-file ML data
filename.ts safe file names from server metadata filename.ts safe file names from server metadata
errors.ts error types shared across layers errors.ts error types shared across layers
@@ -471,7 +470,7 @@ quak files --collection <id> [--json] list files in a collec
quak get <fileID> [--out path] [--collection] download and decrypt a file quak get <fileID> [--out path] [--collection] download and decrypt a file
quak get-thumb <fileID> [--out] [--collection] download and decrypt a thumbnail quak get-thumb <fileID> [--out] [--collection] download and decrypt a thumbnail
quak backup <dir> [--json] full incremental backup quak backup <dir> [--json] full incremental backup
quak backup-metadata <dir> [--exif] dump the metadata quak keeps as JSON quak backup-metadata <dir> [--exif] dump all decrypted metadata as JSON
quak helper list-missing-thumbnails [--json] find files with missing thumbnails quak helper list-missing-thumbnails [--json] find files with missing thumbnails
quak helper fix-missing-thumbnails [--file ids] [--json] generate + upload missing thumbnails quak helper fix-missing-thumbnails [--file ids] [--json] generate + upload missing thumbnails
``` ```
@@ -523,9 +522,7 @@ the smallest does not.
originals/ originals/
<fileID>.<ext> actual file content (one per unique file, <fileID>.<ext> actual file content (one per unique file,
two for a live photo: see below) two for a live photo: see below)
<fileID>.json the file's basic metadata fields quak <fileID>.json all decrypted metadata for that file
keeps, and its private and public magic
metadata
<fileID>.livephoto.json which of a live photo's two files is which <fileID>.livephoto.json which of a live photo's two files is which
collections/ collections/
<name>/ <name>/
@@ -614,7 +611,8 @@ The library's primary surface is the cache-backed `Library`; the lower-level
`Client` sits underneath it and is covered by the Design sections above. The `Client` sits underneath it and is covered by the Design sections above. The
test suite is the canonical, executable documentation — `test/library/` and test suite is the canonical, executable documentation — `test/library/` and
`test/client/usage.test.ts` walk most operations, `test/cli/backup.test.ts` `test/client/usage.test.ts` walk most operations, `test/cli/backup.test.ts`
walks `lib.backup()`, and `yarn test` verifies them. walks `lib.backup()`, and `yarn test` verifies them. No test calls
`getFileByID()`.
### Opening a library ### Opening a library
+6 -8
View File
@@ -41,14 +41,12 @@ declares one.
`logout` open no library; `--exif` records XMP and, for a JPEG, EXIF, and no `logout` open no library; `--exif` records XMP and, for a JPEG, EXIF, and no
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; the default cache directory is the per-user one, not an
keeps and the private and public magic metadata, not every decrypted field; XDG path on macOS; pinned originals can exceed `cacheOriginalsMaxBytes`; which
the default cache directory is the per-user one, not an XDG path on macOS; tests cover which operations; a default read is only as current as the last
pinned originals can exceed `cacheOriginalsMaxBytes`; which tests cover which refresh whose requests all succeeded; `fresh()` and `lib.backup()` join a
operations; a default read is only as current as the last refresh whose refresh already running; a `Photo` has no `thumbnailPath` or `originalPath`;
requests all succeeded; `fresh()` and `lib.backup()` join a refresh already and `408` and `429` are retried.
running; a `Photo` has no `thumbnailPath` or `originalPath`; and `408` and
`429` are retried.
- 2026-09-28: Tested the live-photo writer's fsyncs (issue 130). A test checks - 2026-09-28: Tested the live-photo writer's fsyncs (issue 130). A test checks
that the image's and the video's temp files are fsynced before either is that the image's and the video's temp files are fsynced before either is