This article refers to SpiderOak Groups or Enterprise backup. If you are seeking command line help for SpiderOak One, see the One command line articles instead.
When running SpiderOak Groups or Enterprise from the command line, one available option is --purge-historical-versions
. This removes some or all historical versions that were uploaded from the local computer, on a schedule you can specify. This can free up space in your account. This is a powerful feature, and care should be taken when using it since it permanently removes data.
Users seeking an easier method to remove a few historical versions might be more comfortable doing so via the graphical application.
As a local option, it it only purges historical versions from the device running the command. Attempting to run it on a device other than the one you are seated at with --device will fail with the error "Purging historical versions is only supported from the local device". To purge the historical versions of a different device, you will need to run this command on that device.
It is not possible to restrict the scope to a particular file or directory. It will operate on all of the files and directories that have been uploaded from the local computer, including versions now found in SpiderOak Group's deleted items bin.
This is a one-off command that does not alter Groups historical version retention policy moving forward. Groups will continue to retain all historical versions as before.
Use
To run this command, first completely close SpiderOak Groups, and be sure that all SpiderOak Groups processes have closed correctly. Then:
On Windows
Open a command prompt window. Enter the following text into the window at the prompt, then press enter:
"C:\Program Files\SpiderOak Groups\SpiderOakGroups.exe" --purge-historical-versions --verbose
If the Program Files directory is located on a drive other than C:, change the drive letter as appropriate. If you are running the 32 bit version of SpiderOak on a 64 bit version of Windows, substitute "Program Files (x86)" for "Program Files".
On Mac
Open a terminal. Copy the following text and paste it into the terminal at the prompt, then press enter:
/Applications/SpiderOakGroups.app/Contents/MacOS/SpiderOakGroups --purge-historical-versions --verbose
On Linux
Open a terminal. Copy the following text and paste it into the terminal at the prompt, then press enter:
SpiderOakGroups --purge-historical-versions --verbose
Additional Information
This command may take considerable time before it generates text, so please make sure to not close the program or reopen the application before it has completed. For this reason we recommend using it in conjunction with --verbose
as shown above, which makes the output less laconic.
The --purge-historical-versions
option has three modes:
-
no argument Use the default schedule, which is to keep one version per hour for the last 24 hours, then one version per day for 30 days, then one version per week thereafter.
-
all Purge all historical versions, keeping only the most recent version of each backed up file.
-
specifier Purge according to a schedule you specify. The specifier for setting your own schedule is an argument of the form
hM,dN,w
where M and N are numbers, specifying how many hourly and daily versions to keep, respectively. Leaving undefined a particular value (as for the "w" or weekly part of this example) means unlimited for that value. The option also accepts (m)ontly and (y)early arguments.
Examples
-
--purge-historical-versions
: Keep one hourly version for 24 hours, one daily version for 30 days, then one weekly version thereafter. -
--purge-historical-versions h24,d30,w
: Keep one hourly version for 24 hours, one daily version for 30 days, then one weekly version thereafter. This is the same as the default schedule. -
--purge-historical-versions d60,m6,y
: Keep one daily version for 60 days, one monthly version for 6 months, then one yearly version thereafter. -
--purge-historical-versions w
: Keep one weekly version since the beginning of time. -
--purge-historical-versions all
: Purge all historical versions.
To purge only historical versions which are newer than a specific date, you can simply leave off any older qualifier. For example:
-
--purge-historical-versions d7
: Keep one version a day for seven days, but do not purge versions older than one week. -
--purge-historical-versions d7,m6
: Keep one version a day for seven days and one version a month for six months, but do not purge versions older than six months.
If you have any feedback on this article please let our support team know. Thanks!