Usage

As a CLI Tool

Prerequisites

See installation for detailed instructions on how to set up dfm.

You will also need to set the root path for your usage. The root path will prefix all file paths specified in your config file. This allows dfm to be run from multiple places using the same config file by setting the correct root path on each machine. This can be done in one of three ways:

• Pass in the root path as -r or --root-path in your CLI invocation. This overrides the following two methods.
• Set the DFM_ROOT_PATH environment variable.
• If you do not complete one of the two above points, dfm will default to use / or c:// based on your OS as the root path.

CLI Commands

Once installed, dfm can be run using the following command: dfm merge <local path to config file>.

Optionally you can pass parameters into the merge command. Parameters can be used in path substitution logic to control what files are used in the merge. They are passed using the -p or --parameters flags and the flag's argument being of the form key1=value1,key2=value2....

For example you could also use the following command: dfm merge -p foo=bar,hello=world /files/dfm-config.json

Optionally you can also set your root path at invocation time using the -r or --root-path flags, followed by the desired path. E.g dfm merge -r /foo/bar /files/dfm-config.json. Trailing slashes are ignored

More on the Root Path

Dfm requires a root path to be specified. This is for the following reasons:

• It allows config files to be used by multiple machines. If config files contained full file paths, your entire drive setup would need to be matched by a second machine.
• It will improve the application's performance because less files will need to be traversed when looking for files to merge from/to.

As a Python Package

...