Command Line Interface

The following command line options are supported in the Enterprise Edition of the software. These command line options are supported on both local and remote computers. This is provided as a complementary to the UI program and not as a full fledge alternative to it. Options along with their associated parameters can be placed in any order. For example, you can put the -connect option as a first or last option along with any other option.

mfcmd [-connect HostOrIPAddress [-port ListeningPort] [-key Password] [-saveKey]]
 
      -SaveMirrorOpt MirrorPath [-remote] OptFileName
 
      -AddMirrorPath SourcePath MirrorPath [ArchiveFilePathName] [-(remoteOpt|localOpt) OptFileName]
 
      -EditMirrorPath MirrorPath [ArchiveFilePathName] [-(remoteOpt|localOpt) OptFileName]
 
      -RemoveMirrorPath MirrorPath
 
      -SaveArchiveOpt ArchivePath [-remote] OptFileName
 
      -AddArchivePath SourcePath ArchivePath ArchiveFileName [-(remoteOpt|localOpt) OptFileName]
 
      -EditArchivePath ArchivePath ArchiveFileName [-(remoteOpt|localOpt) OptFileName]
 
      -RemoveArchivePath ArchivePath
 
      -MirrorList (MirrorPath|SourcePath|All)
 
      -ArchiveList (ArchivePath|SourcePath|All)
 
      -StartSync (MirrorPath|SourcePath|All)
 
      -StopSync (MirrorPath|SourcePath|All)
 
      -StartArcv (ArchivePath|SourcePath|All)
 
      -StopArcv (ArchivePath|SourcePath|All)
 
      -DisableMirror (MirrorPath|SourcePath|All)
 
      -EnableMirror (MirrorPath|SourcePath|All)
 
      -DisableArchive (ArchivePath|SourcePath|All)
 
      -EnableArchive (ArchivePath|SourcePath|All)
 
      -Export FilePathName
 
      -Import [-remote] FilePathName

The following parameters can be used in the commands. The path names may contain any environment variables, which will be expanded before executing the command. The command will be run under the current user's account on the local computer, and under the System account on the remote computer. So, values of the environment variables will be different accordingly.

HostOrIPAddress

Host name or IP address of the remote computer where MirrorFolder is running. The given command will be executed on the remote computer.

ListeningPort

The port number to connect on the remote host computer. This is optional in case it was saved earlier for the given host computer.

Password

The password required to connect with the remote host computer. It is optional if saved earlier with the '-saveKey' option

OptFileName

The file name containing synchronization or archiving options saved earlier. If this file is on the remote computer, its full path name is required.

SourcePath

The full source folder or drive path name for which to create a mirror folder or archive file.

MirrorPath

The absolute path name of the mirror folder or drive.

ArchivePath

The absolute path name of the archive folder.

ArchiveFilePathName

The full path name of the archive file. It should have either '.zip' or '.7z' file extension.

ArchiveFileName

The archive file name with '.zip' or '.7z' file extension but without any path name.

FilePathName

Any file name to import or export settings. If it is on the remote computer, the an absolute file path name is required.

All

Denotes all existing source, mirror, and archive path names.

You can execute any one of the following commands at a time along with optional -connect command.

-connect HostOrIPAddress [-port ListeningPort] [-key Password] [-saveKey]

Use the '-connect' option to connect to the MirrorFolder service running on a remote computer and execute any one of the following command options. You need to provide the listening port number with '-port' and the password with the '-key' option for this command. If you include the '-saveKey' option, the given port number and password will be saved locally so that you can later omit the port number and password when connecting to this same host name later. This option is available in the Enterprise Edition of the software.

-SaveMirrorOpt MirrorPath [-remote] OptFileName

Saves the options of the specified mirror path to the given filename. While connected to a remote computer, you can use the '-remote' option to specify a full file path to save the options on the remote computer. Otherwise, the options will be saved on the local computer.

-AddMirrorPath SourcePath MirrorPath [ArchiveFilePathName] [-(remoteOpt|localOpt) OptFileName]

Create a new source and mirror path pair, or add a new mirror path for an existing source path, for mirroring or automated synchronization. You can optionally provide a full archive file path name with either .zip or .7z extension for archiving deleted and replaced files during synchronization. Synchronization options can be provided in an earlier saved local XML file with '-localOpt' option. While connected to a remote computer, you can use the option '-remoteOpt' to provide a full XML file path name containing synchronization options, on the remote computer.

-EditMirrorPath MirrorPath [ArchiveFilePathName] [-(remoteOpt|localOpt) OptFileName]

Edit options for the specified mirror path. You can optionally provide an archive file path name or synchronization options file like above.

-RemoveMirrorPath MirrorPath

Remove the specified mirror path name from the Mirror List.

-SaveArchiveOpt ArchivePath [-remote] OptFileName

Saves the options of the specified archive path to the given filename. While connected to a remote computer, you can use the '-remote' option to specify a full file path to save the options on the remote computer. Otherwise, the options will be saved on the local computer.

-AddArchivePath SourcePath ArchivePath ArchiveFileName [-(remoteOpt|localOpt) OptFileName]

Create a new source and archive path pair, or add a new archive path for an existing source path, for automated archiving of the source path. You need to provide an archive file name with either .zip or .7z extension for creating archive files with timestamp. Archival options can be provided in an earlier saved local XML file with '-localOpt' option. While connected to a remote computer, you can use the option '-remoteOpt' to provide a full XML file path name containing archival options, on the remote computer.

-EditArchivePath ArchivePath ArchiveFileName [-(remoteOpt|localOpt) OptFileName]

Edit options for the specified archive path. You need to provide an archive file name with either .zip or .7z extension. Archiving options can be provided in an XML file like above.

-RemoveArchivePath ArchivePath

Remove the specified archive path name from the Archive List.

-MirrorList (MirrorPath|SourcePath|All)

List the specified mirror path, or all mirror paths of the specified source path, or all mirror paths. The specified path may contain wild card characters '*' or '?'.

-ArchiveList (ArchivePath|SourcePath|All)

List the specified archive path, or all archive paths of the specified source path, or all archive paths. The specified path may contain wild card characters '*' or '?'.

-StartSync (MirrorPath|SourcePath|All)

Start synchronizing the specified mirror path, or all mirror paths of the specified source path, or all mirror paths. The path may also contain wild card characters '*' or '?'.

-StopSync (MirrorPath|SourcePath|All)

Stop the currently running synchronization, if any, for the specified mirror path, or all mirror paths of the specified source path, or all mirror paths. The path may also contain wild card characters '*' or '?'.

-StartArcv (ArchivePath|SourcePath|All)

Start archiving to the specified archive path, or all archive paths of the specified source path, or all archive paths. The path may also contain wild card characters '*' or '?'.

-StopArcv (ArchivePath|SourcePath|All)

Stop the currently running archival process, if any, for the specified archive path, or all archive paths of the specified source path, or all archive paths. The path may also contain wild card characters '*' or '?'.

-DisableMirror (MirrorPath|SourcePath|All)

Disable the specified mirror path, or all mirror paths of the specified source path, or all mirror paths. The path may also contain wild card characters '*' or '?'.

-EnableMirror (MirrorPath|SourcePath|All)

Enable the specified mirror path, or all mirror paths of the specified source path, or all mirror paths. The path may also contain wild card characters '*' or '?'.

-DisableArchive (ArchivePath|SourcePath|All)

Disable the specified archive path, or all archive paths of the specified source path, or all archive paths. The path may also contain wild card characters '*' or '?'.

-EnableArchive (ArchivePath|SourcePath|All)

Enable the specified archive path, or all archive paths of the specified source path, or all archive paths. The path may also contain wild card characters '*' or '?'.

-Export FilePathName

Export all settings into the specified file name in XML format. When connected to a remote computer, this file will created on the remote computer only and the full path name of the file needs to be provided. Exporting settings from a remote computer to local computer is not supported for security reason.

-Import [-remote] FilePathName

Import settings from the specified file. When connected to a remote host, you can pass '-remote' option to specify a full file path name on the remote computer. This can be created using '-export' option earlier.