arq_restore

An open-source command-line utility for restoring from backups created by Arq

Download a binary version here.

Get the source code here.

The data format is documented here.

Usage

arq_restore can list the computers ("backup sets") in your destination (Amazon, S3-compatible, GreenQloud, DreamObjects, Google Cloud Storage, and Google Drive), list the folders in a computer's backup set, and restore a folder.

Get Help

Type arq_restore with no arguments to see usage instructions.


Usage:
    arq_restore [-l loglevel] listtargets
    arq_restore [-l loglevel] addtarget <nickname> aws <access_key> <secret_key>
    arq_restore [-l loglevel] addtarget <nickname> local <path>
    arq_restore [-l loglevel] deletetarget <nickname>

    arq_restore [-l loglevel] listcomputers <target_nickname>
    arq_restore [-l loglevel] listfolders <target_nickname> <computer_uuid>
    arq_restore [-l loglevel] printplist <target_nickname> <computer_uuid> <folder_uuid>
    arq_restore [-l loglevel] listtree <target_nickname> <computer_uuid> <folder_uuid>
    arq_restore [-l loglevel] restore <target_nickname> <computer_uuid> <folder_uuid>
    arq_restore [-l loglevel] clearcache <target_nickname>

log levels: none, error, warn, info, and debug
log output: ~/Library/Logs/arq_restorer

Configuring a Target

arq_restore can view and restore from both AWS and local backup sets. If you've got a backup set at another destination type, copy the backup set's data to a local folder and then add that as a target to restore from.

To configure an AWS target you'll need an access key ID and secret access key to access the AWS data. See the Arq help for more information on creating those keys: Create AWS Key Pair

Listing Computers

To list "computers" (a.k.a. "backup sets"), use the 'listcomputers' command with the nickname for the target you've configured.


$ arq_restore addtarget mydisk local /Volumes/8tb/backups
$ arq_restore listcomputers mydisk
target: mydisk
    computer 725FAF56-B678-4258-BE24-E64E400D750F
        iMac (stefan)
    computer FECF74FB-8DB6-46C0-9B0B-DBC48DC3CBB7
        iMac (stefan)

List Folders

To list the folders in a computer's backup set, use the listfolders command:


$ arq_restore listfolders mydisk 725FAF56-B678-4258-BE24-E64E400D750F
enter encryption password: ...
target   mydisk
computer 725FAF56-B678-4258-BE24-E64E400D750F
    folder /Users/stefan/1somefiles
        uuid 8029F33B-A936-491D-B62D-123997161062

Restore Files

To restore (download) the latest backup of a folder, use the restore command:


$ arq_restore restore mydisk 725FAF56-B678-4258-BE24-E64E400D750F 8029F33B-A936-491D-B62D-123997161062
enter encryption password: ...
target   mydisk
computer 725FAF56-B678-4258-BE24-E64E400D750F
folder   8029F33B-A936-491D-B62D-123997161062

restoring folder /Users/stefan/1somefiles to /Users/stefan/Desktop/1somefiles

2017-02-03 14:38:41.853 arq_restore[27489:446696] setting log file permissions to 666 for /Users/stefan/Library/Logs/arq_restore/arq_restore 2017-02-03 19-38.log
status: Caching object list from mydisk
status: Reading pack list...

...

To restore only a subset of a folder, add the relative path within the folder as an additional argument:


$ arq_restore restore mydisk 725FAF56-B678-4258-BE24-E64E400D750F mypassword 8029F33B-A936-491D-B62D-123997161062 /subdir1/subdir2

...

License

Copyright (c) 2009-2017, Haystack Software LLC http://www.haystacksoftware.com

All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.

* Neither the names of PhotoMinds LLC or Haystack Software, nor the names of 
their contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.