Please update the documentation

[frankspace]

The documentation on the main page reflecting how the original adb-sync worked is confusing and misleading as applied to this rewrite, given that the current adbsync works very differently in some ways that aren't really explained. For example, I used to use adb-sync to back up my camera images like so:

adb-sync -R -n /sdcard/DCIM/ /home/frank/pictures/cellphone_Images/current

where "-R" meant reverse, and "-n" meant no-clobber. Nowhere on the main page is it shown that "--reverse" has been replaced with "--pull", and "-n" now means "dry-run" and there doesn't appear to be a no-clobber option (although it appears, but it isn't stated outright, that not clobbering is the default unless "--del" is passed). Also, the ordering of target and destination directories has changed. So the replacement command would be:

adbsync --pull /home/frank/pictures/cellphone_Images/test /sdcard/DCIM/

...but it took some effort to figure that out. For anybody switching from the original adb-sync, this is likely to be quite confusing (and this is just one example, I'm sure there are plenty of others).

[jb2170]

I'll update the repo / address pending issues in a week or so, when I'm freed up a bit.
Yeah the old readme is just #included in this one, could be neatened up.
I'm considering changing the syntax from adb-sync LOCAL ANDROID [--pull] to adb-sync {push|pull} SRC DEST to be more like rsync and adb's syntax, similar to how adb uses adb {push|pull}

[ralyodio]

you're cli is not found when i install it on arch....please update docs.

also will this allow me to complete clone from one fire stick to another?

[JayGoldberg]

I'm baffled at how to use this tool.

$ adbsync pull ANDROID LOCAL
ANDROID: FileNotFoundError
Exiting

$ adbsync pull ./Downloads/ ./
Downloads: FileNotFoundError
Exiting

$ adbsync pull Downloads/ ./
Downloads: FileNotFoundError
Exiting

$ adbsync ANDROID LOCAL
usage: adbsync [-h] [--version] [--no-color] [-v | -q] [-n] [-L] [--exclude EXCLUDE]
               [--exclude-from EXCLUDE_FROM] [--del] [--delete-excluded] [--force] [--show-progress]
               [--adb-encoding ADB_ENCODING] [--adb-bin ADB_BIN] [--adb-flag ADB_FLAG]
               [--adb-option OPTION VALUE]
               {push,pull} ...
adbsync: error: argument direction: invalid choice: 'ANDROID' (choose from 'push', 'pull')

$ adbsync ANDROID:Downloads/ LOCAL:./
usage: adbsync [-h] [--version] [--no-color] [-v | -q] [-n] [-L] [--exclude EXCLUDE]
               [--exclude-from EXCLUDE_FROM] [--del] [--delete-excluded] [--force] [--show-progress]
               [--adb-encoding ADB_ENCODING] [--adb-bin ADB_BIN] [--adb-flag ADB_FLAG]
               [--adb-option OPTION VALUE]
               {push,pull} ...
adbsync: error: argument direction: invalid choice: 'ANDROID:Downloads/' (choose from 'push', 'pull')

$ adbsync pull ANDROID:Downloads/ LOCAL:./
ANDROID:Downloads: FileNotFoundError
Exiting

$ adbsync pull ANDROID LOCAL Downloads ./
usage: adbsync [-h] [--version] [--no-color] [-v | -q] [-n] [-L] [--exclude EXCLUDE]
               [--exclude-from EXCLUDE_FROM] [--del] [--delete-excluded] [--force] [--show-progress]
               [--adb-encoding ADB_ENCODING] [--adb-bin ADB_BIN] [--adb-flag ADB_FLAG]
               [--adb-option OPTION VALUE]
               {push,pull} ...
adbsync: error: unrecognized arguments: Downloads ./

[JayGoldberg]

Finally got it:

$ adbsync pull /storage/emulated/0 ./

I assumed the path was relative from SDcard, not from root on Android.

Maybe will do a PR to clarify the ABSOLUTE_PATH_ANDROID and LOCAL_PATH as the placeholders and not literals. I think in Linux commands these kinds of args are denoted with <> or [].