Command Reference

Clean

parallel clean [--path] [--days] [--recursive] [--verbose]

Cleans up the local file system by removing older files. This only removes files outside of the RetentionPeriod in the main configuration file or by using the --days option.

Parameter	Short hand	Type	Required	Description
path	-p	string	No	The source path to clean.
days	-d	int	No	The amount of days to hang onto files.
recursive	-R	bool	No	If to include subdirectories.
verbose	-v	bool	No	Shows verbose output.

Note: The days specified in the command cannot be lower than the RetentionPeriod in the main config.

Restore

parallel restore [--path] [--config] [--before] [--remap] [--force]

Restores files from a vault. By default, this will be the first enabled vault unless the --config option is specified. It's important to note that when using the --path option, the path refers to the local system path where the file was backed up.

Sometimes you might want to restore or move files between vaults or different computers. In these instances, it's recommended to use the --remap option. This will replace the original file path, allowing you to move files wherever you like while preserving the original folder structure.

For example, if you are having Parallel sync Windows fonts, these cannot be restored and will need to be reinstalled. In this case, you will need to convert the file path from C:\Windows\Fonts\Arial.ttf to C:\Users\Admin\Desktop\Fonts\Arial.ttf by running this command:

parallel restore --path "C:\Windows\Fonts" --remap "C:\Users\Parallel\Desktop\Fonts"

It's also important to note that this works between operating systems. If you're moving from Windows to Linux, you can sync all your documents and then restore them via:

parallel restore --path "C:\Users\Parallel\Documents" --remap "/home/parallel/Documents"

Parameter	Short hand	Type	Required	Description
path	-p	string	No	The source path to restore.
config	-c	string	No	The vault configuration to use.
before		datetime	No	Restores files before a certain timestamp.
remap		string	No	The output directory remapping.
force	-f	bool	No	Forces overwriting any files.
dry-run		bool	No	Previews a command without executing it.

Sync

parallel sync [--path] [--config] [--force]

Backs up the current file system with the vaults. By default, it will only sync to enabled vaults unless the --config option is specified. Parallel can only sync files specified in the backup directories listed in the parallel vaults view <Vault ID> command. The default directories are the same across all platforms:

• Desktop
• Documents
• Music
• Pictures
• Videos

Parameter	Short hand	Type	Required	Description
path	-p	string	No	The source path to back up.
config	-c	string	No	The vault configuration to use.
force	-f	bool	No	Forces overwriting any files.

Note: You can add or remove directories via the subcommands below.

Sync add

parallel sync add <path> [--config]

Adds a new directory to the backup list.

Parameter	Short hand	Type	Required	Description
path	None	string	Yes	The path to add.
config	-c	string	No	The vault configuration to use.

Sync remove

parallel sync remove <path> [--config]

Removes a directory from the backup list.

Parameter	Short hand	Type	Required	Description
path	None	string	Yes	The path to remove.
config	-c	string	No	The vault configuration to use.