Support & Knowledge Base


Still have questions? We have answers! Check out our Frequently Asked Questions for everything you need on SpiderOak

How can I use SpiderOak from the commandline?

Command line operation is available on all operating systems: Windows, Mac OS X, and Linux.

Running SpiderOak with --help should give you the general overview.

The most common uses of SpiderOak from the command line are --headless to run SpiderOak without any graphical user interface, and --batchmode which will run without any graphical interface, and exit SpiderOak as soon as all uploads are complete. You can also modify your backup selection through the --include and --exclude options.

Paths to the executable:
On Mac OS X: /Applications/
On Ubuntu: /usr/bin/SpiderOak
On Windows: C:\"Program Files"\SpiderOak\SpiderOak.exe

This is a full list of command line options:

Usage: SpiderOak basic command line usage:

Options: --version show program's version number and exit -h, --help show this help message and exit -v, --verbose be verbose

Operational Modes and Commands: --backup=TARGET ad hoc operation: backup whatever exists at TARGET in the filesystem and exit (ignores existing backup selection.) --headless run in headless mode (without the graphical interface) --batchmode like headless, but will exit when all available work is done --scan-only scan the filesystem for changes and report a summary --scan-and-build-only scan the filesystem, and build all possible file system changes as shelved upload transactions, and exit without uploading them

Information Commands: --userinfo, --user-info Show user and device info --space Show space usage information by category and by device --tree Show the hierarchy of stored backup folders --tree-changelog Show a log of how the hierarchy of stored backup folders has changed over time --journal-changelog=folder_or_journal Show the changelog of a given folder --shelved-x, --print-shelved-x Show information about each shelved upload transaction

Backup Selection Manipulation Commands: --selection, --print-selection Show a list of selected and excluded backup items --reset-selection Reset selection (but preserve excluded files) --exclude-file=EXCLUDE_FILE Exclude the given file from the selection --exclude-dir=EXCLUDE_DIR Exclude the given directory from the selection --include-dir=INCLUDE_DIR Include the given directory in the selection --force Do in/exclusion even if the path doesn't exist

Maintenance Commands: --vacuum Vacuum SpiderOak's local database (rebuilds indexs and reclaims space)

                    rebuild the SpiderOak reference database (can take

--repair Bring SpiderOak up to date with our servers

--purge purge a device: --device=(device number here) --purge=(filename path here)
purge a file: --device=(device number) --purge=(file pathname)

--fulllist prints a complete list of all files and folders backed up to SpiderOak. As this is usually quite long, it may also be helpful to run --redirect

--redirect redirects the output of a command to a new text file: --redirect path/to/new/file.txt

--purge-historical-versions used to purge historical versions; the default command still leaves some versions present. For more instructions see

Dangerous/Support Commands: Caution: Do not use these commands unless advised by SpiderOak support. They can damage your installation if used improperly.

                    purge all deleted items on the current device
                    destroy each shelved upload transaction (not intended
                    for general use -- this will damage your break your
                    account if not used correctly)
                    apply all transactions previously received from remote
                    devices -- (not intended for general use -- this
                    normally happens automatically)

Couldn't find an answer to your question? Email our support with your question.

Have a Question?