Two things in aw-sync/README.md are actively misleading, and both point users at broken or non-existent behaviour.
1. It recommends the path that does not work
The Usage section opens with:
This will start a daemon which pulls and pushes events with the sync directory (~/ActivityWatchSync by default) every 5 minutes:
Per #682, bare aw-sync / aw-sync daemon never pulls anything — it scans two directory levels while real peers live three levels down. The command that actually works today is aw-sync sync, which the README presents further down as the lesser "sync all buckets once and exit" option.
Once #685 merges this section becomes correct, so the fix is either to land alongside it or to carry an interim note. It should not be left as-is in a release where the daemon still no-ops.
2. It says Android is unsupported
Under Limitations:
- It doesn't support Android, yet.
Android sync shipped. aw-android drives this same crate over JNI (syncPull, syncPullAll, syncPush, syncBoth in aw-sync/src/android.rs), and aw-android v0.14.1 is on the Play Store with a sync settings screen. The limitation immediately above it —
- It only syncs afk and window buckets by default
— also no longer matches the code: SyncSpec.buckets: None means all buckets, and --buckets is opt-in filtering rather than the default.
Also worth refreshing
Small and self-contained — reasonable good first issue if nobody picks it up with #685.
cc @TimeToBuildBob
Two things in
aw-sync/README.mdare actively misleading, and both point users at broken or non-existent behaviour.1. It recommends the path that does not work
The Usage section opens with:
Per #682, bare
aw-sync/aw-sync daemonnever pulls anything — it scans two directory levels while real peers live three levels down. The command that actually works today isaw-sync sync, which the README presents further down as the lesser "sync all buckets once and exit" option.Once #685 merges this section becomes correct, so the fix is either to land alongside it or to carry an interim note. It should not be left as-is in a release where the daemon still no-ops.
2. It says Android is unsupported
Under Limitations:
Android sync shipped. aw-android drives this same crate over JNI (
syncPull,syncPullAll,syncPush,syncBothinaw-sync/src/android.rs), and aw-android v0.14.1 is on the Play Store with a sync settings screen. The limitation immediately above it —— also no longer matches the code:
SyncSpec.buckets: Nonemeans all buckets, and--bucketsis opt-in filtering rather than the default.Also worth refreshing
{hostname}/{device_id}/test.dblayout looks like. aw-sync: sync failures are silent — addaw-sync status, loud diagnostics, per-device manifest, and surface peers in Raw Data #684 covers making this discoverable in the tool; the README is the cheaper half.Small and self-contained — reasonable
good first issueif nobody picks it up with #685.cc @TimeToBuildBob