Odrive Sync Agent

Odrive Sync Agent (beta): A CLI/scriptable interface for odrive's Progressive Sync Engine for Linux, OS X, and Windows - General - odrive Community





really cool gateway between cloud services

Make Cloud Storage

THE WAY IT SHOULD BE

Meet odrive, your universal sync client. It makes any cloud storage unified, synchronized, shareable, and encrypted.

Currently I am using google drive, dropbox and opendrive.com



.odrive-agent/bin/odrive mount odrive-agent-mount /

get all drivers linked with odrive


.odrive-agent/bin/odrive mount odrive-agent-mount/Dropbox/myfolder.cloudf /mnt/odrive/

mount the and link dropbox/myfolder on /mnt/drive


python ~/.odrive-agent/bin/odrive.py sync /mnt/Dropbox

Syncs the drive


-----

Odrive Sync Agent (beta): A CLI/scriptable interface for odrive’s Progressive Sync Engine for Linux, OS X, and Windows

2

 / 

35

 

Tony

Mar 25

15 

• Overview
• Installing odrive Sync Agent1
  • Windows1
  • OS X5
  • Linux24
• odrive Sync Agent quick start guide2
• Available commands
• Helpful tips
• Direct download links3

Overview

The odrive Sync Agent provides advanced users with a flexible, scriptable interface to odrive’s powerful Progressive Sync engine. Use it to bring cloud access to almost any environment.
The odrive Sync Agent can be used on Windows (7+), OS X (10.7+), and Linux (glibc 2.11+) operating systems.

Sync Agent service (odriveagent/odriveagent.exe)

This is the “engine” and runs persistently. It will react to filesystem and remote changes and listen for commands from the Sync Agent client.

Sync Agent client (odrive.py/odrive/odrive.exe)

This is the client interface to the Sync Agent server. The Sync Agent client is used from the command-line or from shell scripts to control and enhance Sync Agent behavior. The client is written in python and can be extended and customized to add additional functionality and automation, as well.

Installing odrive Sync Agent

Windows installation

Open up powershell and run the following command to download and install the odrive Sync Agent to .odrive-agent in your user home directory. This will download the odrive Agent service, the odrive Agent python client, and the odrive Agent binary client. The command doesn't give much feedback, so just give it some time:

$o="$HOME\.odrive-agent\bin";mkdir "$o" -FORCE;(New-Object System.Net.WebClient).DownloadFile("http://bit.ly/1qHUWlf","$o\odrive.py");(New-Object System.Net.WebClient).DownloadFile("http://bit.ly/1YMZjGL", "$o\o.zip");$shl=new-object -com shell.application; $shl.namespace("$o").copyhere($shl.namespace("$o\o.zip").items(),0x10);del "$o\o.zip";(New-Object System.Net.WebClient).DownloadFile("http://bit.ly/1Vtmvfi", "$o\oc.zip");$shl=new-object -com shell.application; $shl.namespace("$o").copyhere($shl.namespace("$o\oc.zip").items(),0x10);del "$o\oc.zip";

To run the odrive Sync Agent server in the background, use the following command in powershell:

Start-Job { & "$HOME\.odrive-agent\bin\odriveagent.exe" }

Now the odrive Sync Agent server is running and you can use the odrive Sync Agent client to control it. For example, the following command will display the available client commands:
Python client

python ~/.odrive-agent/bin/odrive.py -h

Binary client

~/.odrive-agent/bin/odrive.exe -h

The following command will show the current status of the odrive Sync Agent:
Python client

python ~/odrive-agent/bin/odrive.py status

Binary client

~/.odrive-agent/bin/odrive.exe status

OS X installation

Run the following command in your terminal to download and install the odrive Sync Agent to ~/.odrive-agent. This will download the odrive Agent service, the odrive Agent python client, and the odrive Agent binary client.:

od="$HOME/.odrive-agent/bin" && curl -L "http://bit.ly/1qHUWlf" --create-dirs -o "$od/odrive.py" && curl -L "http://bit.ly/1Wj1iUh" | tar -xvzf- -C "$od/" && curl -L "http://bit.ly/1YN3PoD" | tar -xvzf- -C "$od/"

To run the odrive Sync Agent server in the background, use the following command in your terminal:

nohup ~/.odrive-agent/bin/odriveagent.app/Contents/MacOS/odriveagent>/dev/null&

Now the odrive Sync Agent server is running and you can use the odrive Sync Agent client to control it. For example, the following command will display the available client commands:
Python client

python ~/.odrive-agent/bin/odrive.py -h

Binary client

~/.odrive-agent/bin/odrive -h

The following command will show the current status of the odrive Sync Agent
Python client

python ~/odrive-agent/bin/odrive.py status

Binary client

~/.odrive-agent/bin/odrive status

Linux installation

Run the following command in your terminal to download and install the odrive Sync Agent to ~/.odrive-agent. This will download the odrive Agent service, the odrive Agent python client, and the odrive Agent binary client.:
32bit Linux

od="$HOME/.odrive-agent/bin" && curl -L "http://bit.ly/1qHUWlf" --create-dirs -o "$od/odrive.py" && curl -L "http://bit.ly/1SWM15X" | tar -xvzf- -C "$od/" && curl -L "http://bit.ly/1rrjK1Z" | tar -xvzf- -C "$od/"

64bit Linux

od="$HOME/.odrive-agent/bin" && curl -L "http://bit.ly/1qHUWlf" --create-dirs -o "$od/odrive.py" && curl -L "http://bit.ly/217PqoX" | tar -xvzf- -C "$od/" && curl -L "http://bit.ly/1TpyyH2" | tar -xvzf- -C "$od/"

To run the odrive Sync Agent server in the background, use the following command in your terminal:

nohup ~/.odrive-agent/bin/odriveagent>/dev/null&

Now the odrive Sync Agent server is running and you can use the odrive Sync Agent client to control it. For example, the following command will display the available client commands:
Python client

python ~/.odrive-agent/bin/odrive.py -h

Binary client

~/.odrive-agent/bin/odrive -h

The following command will show the current status of the odrive Sync Agent
Python client

python ~/odrive-agent/bin/odrive.py status

Binary client

~/.odrive-agent/bin/odrive status

odrive Sync Agent quick start guide

Now that you have the odrive Sync Agent installed and running, it is time to start playing with it!

1. Create an odrive account
   If you don’t have an odrive account yet, you can get one here: https://www.odrive.com
2. Create an auth key for odrive Agent
   Once you have created an account/signed-in, navigate to https://www.odrive.com/account/authcodes7 and click on “Create Auth Key” to create an auth key that you can then use to authenticate your odrive Sync Agent install.
3. Authenticate odrive Sync Agent
   

   authenticate [auth key]

   Python client
   

   python ~/.odrive-agent/bin/odrive.py authenticate 00000000-0000-0000-0000-000000000000-00000000

   OS X/Linux binary client
   

   ~/.odrive-agent/bin/odrive authenticate 00000000-0000-0000-0000-000000000000-00000000

   Windows binary client
   

   ~\.odrive-agent\bin\odrive.exe authenticate 00000000-0000-0000-0000-000000000000-00000000

4. Create an agent mount
   This will mount the root of your odrive to the local folder “odrive-agent-mount”. Make sure the local folder exists before attempting to mount:
   

   mkdir "~/odrive-agent-mount"

   You can then mount and see your odrive links listed in ./odrive-agent-mount
   

   mount [remote odrive folder] [local folder]

   Python client
   

   python ~/.odrive-agent/bin/odrive.py mount / ./odrive-agent-mount

   OS X/Linux binary client
   

   python ~/.odrive-agent/bin/odrive mount / ./odrive-agent-mount

   Windows binary client
   

   ~\.odrive-agent\bin\odrive.exe mount / .\odrive-agent-mount

5. Sync an odrive folder
   

   sync [path to .cloudf placeholder file]

   Python client
   

   python ~/.odrive-agent/bin/odrive.py sync ./odrive-agent-mount/Dropbox.cloudf

   OS X/Linux binary client
   

   ~/.odrive-agent/bin/odrive sync ./odrive-agent-mount/Dropbox.cloudf

   Windows binary client
   

   ~\.odrive-agent\bin\odrive.exe sync .\odrive-agent-mount\Dropbox.cloudf

6. Sync a file
   

   sync [path to .cloud placeholder file]

   Python client
   

   python ~/.odrive-agent/bin/odrive.py sync ./odrive-agent-mount/Dropbox/myfile.txt.cloud

   OS X/Linux binary client
   

   ~/.odrive-agent/bin/odrive sync ./odrive-agent-mount/Dropbox/myfile.txt.cloud

   Windows binary client
   

   ~\.odrive-agent\bin\odrive.exe sync .\odrive-agent-mount\Dropbox\myfile.txt.cloud`

Available commands

authenticate - authenticate odrive with an auth key
mount - mount remote odrive path to a local folder
unmount - remove a mount
sync - sync a placeholder
stream - stream a placeholder eg. stream path | appExecutable -
refresh - refresh a folder
unsync - unsync a file or a folder
syncstate - get sync status info (blue text is Synced, Pink is Active)
status - get status info
deauthorize - deauthorize odrive to unlink the current user and exit
empty trash - empty odrive trash
shutdown - shutdown odrive
status also has the following flags for details:
--mounts get status on mounts
--sync_requests get status on sync requests
--uploads get status on uploads
--downloads get status on downloads
--background get status on background requests
--trash get status of trash items
--waiting get status of waiting items
--not_allowed get status of not allowed items

Helpful tips

Detailed help
You can get more detailed help on individual commands. For example:

authenticate -h

Watch realtime status
Windows

while(1){~\.odrive-agent\bin\odrive.exe status;start-sleep -seconds 1}

OS X/Linux

while true; do ~/.odrive-agent/bin/odrive status; sleep 1; done

Logs
An odrive Sync Agent log file is located at ~/.odrive-agent/log/agent.log
Streaming
To stream a file, use standard piping commands such as:

~/.odrive-agent/bin/odrive stream placeholderPath | playerExecutablePath -

On windows this works in cmd.exe, but not in powershell
Recursive Sync

Tony:

I took a quick stab some one-liner, bash-based recursion. I'm sure there are better ways to do this in bash and there are certainly better ways to do this in Python, but I figured I would get the ball rolling. I haven't looked at a Python-based solution or Windows yet. This uses find to recurse and sync. The output is not ideal, though, since it is all queued up. You would need to change the path, of course: output="go"; while [ "$output" ]; do output=$(find ~/agent/odrive/Dropbox/ -name "*.…

Copy, Sync, Unsync Automation

Tony:

For your backup and unsync use case, you can script something like this in bash: agentdir=~/agent export agentdir; agentmount=$agentdir/odrive targetdir=$agentmount/temp sourcedir=~/Downloads/test_directory $agentdir/odrive.py sync $targetdir.cloudf cp -R $sourcedir $targetdir/ $agentdir/odrive.py refresh $targetdir echo Waiting for odrive to start syncing $targetdir ... while [ $($agentdir/odrive.py syncstate $targetdir | head -n 1) == 'Synced' ]; do ` sleep 5 done echo odrive is syncing …

Direct download links (Beta v2)

If you use the install instructions above you will get these versions
odrive Sync Agent client (Python): http://bit.ly/1qHUWlf4
odrive Sync Agent client (Linux 32bit binary): http://bit.ly/1rrjK1Z3
odrive Sync Agent client (Linux 64bit binary): http://bit.ly/1TpyyH23
odrive Sync Agent client (OS X binary): http://bit.ly/1YN3PoD1
odrive Sync Agent client (Windows binary): http://bit.ly/1Vtmvfi1
odrive Sync Agent service (Linux 32bit binary): http://bit.ly/1SWM15X1
odrive Sync Agent service (Linux 64bit binary): http://bit.ly/217PqoX6
odrive Sync Agent service (OS X binary): http://bit.ly/1Wj1iUh1
odrive Sync Agent service (Windows binary): http://bit.ly/1YMZjGL2