Update wiki for v0.21.0

rhoopr committed Jun 1, 2026

Document recent scope

rhoopr committed Jun 1, 2026

Update wiki for v0.20 release

rhoopr committed May 24, 2026

Update wiki for v0.20 config migration

rhoopr committed May 18, 2026

Update wiki for v0.14.2

rhoopr committed May 16, 2026

Add service guide

rhoopr committed May 16, 2026

v0.13: document selection + folder-structure flag redesign Update CLI-album, CLI-exclude-album (deprecated), CLI-library, CLI-folder-structure to reflect the new repeatable / sentinel / inline-exclusion grammar. Add CLI-smart-folder, CLI-unfiled, CLI-folder-structure-albums, CLI-folder-structure-smart-folders pages for the new v0.13 flags. Refresh Folder-Structure, Content-Filtering, Sync, Import-Existing, Configuration, Home for the three-template-per-pass model. Migration pointer points at docs/v0.13-migration.md in the main repo.

rhoopr committed May 2, 2026

Truth-up wiki against main 0.12.1-dev: schema v7, deprecation pointers, residual flag renames Companion to https://github.com/rhoopr/kei/pull/315. Origin already had the bulk of the v0.11.x → v0.12.0 rename work (CLI‑metrics-port → CLI‑http-port, [server] section in Configuration, --download-dir in Docker entrypoint); this commit fills in the remaining gaps. State-Tracking - Bump documented schema version 4 → 7. Describe v5 metadata columns + asset_albums / asset_people tables, v6 metadata_write_failed_at, v7 sync_runs.status lifecycle column. Note status alongside the legacy `interrupted` boolean. Deprecation-pointer pages - Convert CLI‑threads-num, CLI‑retry-delay, and CLI‑directory to one-screen migration pointers; the canonical pages are CLI‑threads, CLI‑max-retries, and CLI‑download-dir. - Add CLI‑metrics-port (deprecation pointer kept for old links even though origin renamed the file). New canonical CLI pages - CLI‑threads, CLI‑download-dir, CLI‑http-bind, CLI‑retry-failed. - CLI‑bandwidth-limit refreshed to reference --threads (not the deprecated --threads-num). Cross-page sweeps for residual stale references on pages origin didn't touch: - --directory → --download-dir in Watch-Mode, Folder-Structure, Import-Existing, Credentials, Docker, CLI‑password-file, CLI‑notify-systemd, CLI‑folder-structure, Home. - --threads-num → --threads in Home, Download-Pipeline, CLI‑config, and the CLI‑report-json sample JSON. - Drop --retry-delay references from Retry, CLI‑max-retries, CLI‑max-download-attempts, Download-Pipeline, Sync; rewrite the Retry page's backoff table around --max-retries. Configuration.md: switch the TOML example from threads_num to threads, drop the explicit `delay` line from [download.retry] (now derived from max_retries), add `bind = "0.0.0.0"` to [server], and document threads_num / [download.retry] delay under Deprecated keys. Sync.md: link --max-download-attempts and --retry-failed to their pages; rename --threads-num and --directory rows; fold --retry-delay note into the --max-retries description.

rhoopr committed Apr 30, 2026

Add Install page (moved from README) FreeBSD, build-from-source, and binary download instructions moved out of README to keep that file high-level. Home and sidebar link to the new page.

rhoopr committed Apr 23, 2026

Sync wiki with v0.11.x codebase - Rename CLI‑metrics-port → CLI‑http-port (renamed in PR #237); rewrite to reflect that the HTTP server is always on in watch mode with a default port of 9090, and to list deprecated names still accepted. - Configuration.md: swap `[metrics]` for `[server]`; drop the incorrect `max_download_attempts` key under `[download]` (CLI-only, would break configs under `deny_unknown_fields`); add missing keys `bandwidth_limit`, `set_exif_rating`, `set_exif_gps`, `set_exif_description`, `embed_xmp`, `xmp_sidecar`; document the full list of CLI-only flags and the deprecated keys (`[metrics]`, `skip_live_photos`, `cookie_directory`). - Home.md: add `reconcile` to the commands table and subcommand section; update sync key-flag list (`--bandwidth-limit`, `--http-port`). - Docker.md: rewrite the Health checks section to match the actual HEALTHCHECK (`curl -f http://localhost:9090/healthz`) instead of the old file-based health.json reader; rewrite Prometheus section (the HTTP server runs by default in watch mode, not opt-in); refresh the Tags table to match the real publish patterns (semver, major.minor, short SHA, latest). - Sync.md: surface flags that existed in code but weren't documented on the sync page (`--bandwidth-limit`, `--set-exif-rating`, `--set-exif-gps`, `--set-exif-description`, `--embed-xmp`, `--xmp-sidecar`, `--http-port`); link `--save-password` page. - Content-Validation.md: fix broken link (was pointing at CLI‑set-exif-datetime, now at Verify). - CLI‑set-exif-datetime.md: add env/TOML rows, fix double-period typo. - CLI‑watch-with-interval.md: document the 86400 upper bound; add env and TOML rows.

rhoopr committed Apr 23, 2026

Document --metrics-port / Prometheus /metrics + /healthz

rhoopr committed Apr 18, 2026

Document v0.8.0: --report-json, extended notification vars, sync summary - New CLI-report-json.md: JSON schema, stats fields, skip breakdown, example output - CLI-notification-script.md: 21 new KEI_* env vars (counts, transfer, errors, skip breakdown) - Sync.md: add --report-json to operational flags table - Home.md: add --report-json to sync key flags - Download-Pipeline.md: sync summary section, bandwidth/disk tracking - Docker.md: JSON sync reports section with KEI_REPORT_JSON env var

rhoopr committed Apr 16, 2026

Docs cleanup: auth flow, max-download-attempts, live-photo-size default, config reference

rhoopr committed Apr 15, 2026

Restructure wiki around subcommands Add dedicated pages for each subcommand (sync, login, list, password, reset, config, status, verify, import-existing). Reorganize the Home page CLI Reference by subcommand instead of flat flag tables. Slim down the sidebar to link subcommand pages instead of 45 individual flags. Fix deprecated cross-references throughout: --list-albums -> kei list albums, --list-libraries -> kei list libraries, --auth-only -> kei login, --reset-sync-token -> kei reset sync-token, --skip-live-photos -> --live-photo-mode.

rhoopr committed Apr 13, 2026

ADP: require both settings in Home.md

rhoopr committed Apr 13, 2026

Document ADP incompatibility and 421/403 failure modes

rhoopr committed Apr 13, 2026

Update wiki for v0.7.0: new commands, filters, deprecations - Add CLI pages: live-photo-mode, exclude-album, filename-exclude, data-dir - Update all references: credential->password, cookie-directory->data-dir, get-code->login get-code, retry-failed->sync --retry-failed, etc. - Mark deprecated flags: auth-only, list-albums, list-libraries, skip-live-photos, cookie-directory, reset-sync-token - Update Content-Filtering, Folder-Structure, Configuration, Docker, Authentication, Credentials, State-Tracking, Live-Photos, Home

rhoopr committed Apr 11, 2026

Use explicit `kei sync` in all command examples Update all wiki examples to use `kei sync` instead of bare `kei` when passing sync flags. Deprecated flag pages (auth-only, list-albums, list-libraries, cookie-directory) are left unchanged.

rhoopr committed Apr 9, 2026

Update wiki for CLI refactor (v0.7.0) New subcommand hierarchy: login, list, password, config, reset. --data-dir replaces --cookie-directory. KEI_* env vars documented. Old commands/flags still work with deprecation notices.

rhoopr committed Apr 9, 2026

Add --only-print-filenames wiki page

rhoopr committed Apr 8, 2026

Update wiki for v0.6.0: credentials, password sources, Docker, and robustness changes New pages: Credentials, CLI-password-file, CLI-password-command, CLI-save-password. Updated: Authentication, Docker, Configuration, Watch-Mode, Download-Pipeline, Live-Photos, Retry, Home, Sidebar, and CLI pages for auth-only, max-retries, retry-delay, watch-with-interval, password.

rhoopr committed Apr 6, 2026

Rename icloudpd-rs to kei across all wiki pages - Binary/project name: icloudpd-rs → kei - Cookie directory default: ~/.icloudpd-rs → ~/.config/kei/cookies - Config path default: ~/.config/icloudpd-rs/config.toml → ~/.config/kei/config.toml - Temp suffix default: .icloudpd-tmp → .kei-tmp - Docker image: ghcr.io/rhoopr/icloudpd-rs → ghcr.io/rhoopr/kei - Homebrew: brew install rhoopr/kei/kei - Notification env vars: ICLOUDPD_* → KEI_* - Add setup subcommand to commands table - Update Docker version tag to v0.5.0

rhoopr committed Apr 2, 2026

Update wiki for --library all (#98)

rhoopr committed Mar 11, 2026

Add incremental sync docs and CLI reference pages Add --no-incremental and --reset-sync-token CLI pages. Add incremental sync section to State Tracking with fallback and recovery details. Update Download Pipeline, Watch Mode, Configuration, Home, and Sidebar for syncToken support.

rhoopr committed Mar 10, 2026

Update wiki for v0.3.0: Docker notification walkthrough, install instructions, EXIF compat note - Docker: update base image description, add full notification script setup walkthrough (host file, env vars, config.toml reference) - Home: replace cargo build with brew/docker install, add submit-code, --config, --notification-script, Configuration and Docker links - Configuration: list all 5 --size values, add interval comment on skip_created_before - Exif: add compatibility note on size difference vs Python piexif - Authentication: add headless MFA section - Sidebar: add Configuration, Docker, --config, --notification-script, Migration links - Add new pages: CLI-config, CLI-notification-script, Configuration, Docker, Migration-from-Python

rhoopr committed Mar 8, 2026

Update wiki for v0.2.0 release

rhoopr committed Feb 9, 2026

Add --library, --force-size, --keep-unicode-in-filenames docs

Rob Hooper committed Feb 9, 2026

docs: update wiki for v0.1.0 release

rhoopr committed Feb 4, 2026

Document progress bar feature and --no-progress-bar flag Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

rhoopr committed Feb 1, 2026

Add documentation from docs/ to wiki

rhoopr committed Feb 1, 2026