Command line operation of SpiderOak ONE and Groups is available on all supported desktop operating systems: Windows, Mac, and Linux. Here is a brief overview of the command line's available options, with links to more detailed information.
- Show program's version number and exit.
- Show this help message and exit.
- Be verbose: show detailed status information as it happens.
- Redirect console output to file.
--d DEVICE_NUMBER, --device=DEVICE_NUMBER
- Run the command for the specified device. Note that some commands are local only. Default is local device.
- Connect to a running instance and shut it down.
Operational Modes and Commands
- Scan the filesystem for changes and report a summary.
- Scan the filesystem, and build all possible file system changes as shelved upload transactions, and exit without uploading them.
- Like batchmode, but only backup/update synced directories.
- Ad hoc operation: back up whatever exists at TARGET in the filesystem and exit (ignores existing backup selection).
- Like headless, but will exit when all available work is done.
- Run in headless mode (without the graphical interface).
- Purge a directory or file (including historical versions).
- Honor the set activity schedule, even in batchmode (normally the schedule is ignored in batchmode).
- Disable activity scheduling.
- Enables the shell integration features (Windows only).
- Disables the shell integration features (Windows only).
- Show user and device info.
- Show information about each shelved upload transaction.
- Show space usage information by device.
- Show the hierarchy of stored backup directories.
- Show all directories and files stored on device.
- Show a log of how the hierarchy of stored backup directories has changed over time.
- Show the changelog of a given directory.
Backup Selection Manipulation Commands
- Show a list of selected and excluded backup items.
- Reset selection (but preserve excluded files).
- Exclude the given file from the selection.
- Include the given file in the selection.
- Exclude the given directory from the selection.
- Include the given directory in the selection.
- Do in/exclusion even if the path doesn't exist.
- Rebuild the SpiderOakONE reference database (can take awhile).
- Clear the queue of all transactions, such as file uploads.
- Repair a local SpiderOakONE installation.
- Purge historical versions:
- "all": purge all historical versions of all files.
- "hM,dN,w": hourly for last M hours, daily for last N days, weekly thereafter (also accepts (m)onthly and (y)early).
- No option: hourly for last 24 hours, daily for last month, then weekly thereafter.
- Purge deleted items older than specified number of days.
- Vacuum SpiderOakONE's local database (rebuilds indexes and reclaims local disk space).
- List parent_id's of unreferenced external block files.
freeunused database files. Use
--orphans=helpfor more info.
- Generate missing image previews for the local device.
- Print a secure link for billing access.
- Rename the specified device with name NEWNAME.
- Create or reinstall a device by reading parameters from the specified JSON file. Use
--setup=-to be prompted interactively for parameters. Use
--setup=helpfor more info.
- List shares.
- Delete the ShareRoom with the given RoomKey.
- Creates a link to share the specified file.
- Restore a directory or file. Run
--restore helpfor more info.
-o DIR, --output=DIR
- Target directory to restore items to (default is normal download directory).
- Use this option together with
--restoreto restore data as stored at DATE. Format: YYYY-MM- DD[/HH:MM[:SS]].
- Use this option together with
--restoreto simulate the download and list the files to download.
- Retrieve metadata held by server according to policy.
If you have any feedback on this article please let our support team know. Thanks!