Skip to content

Installation

ServerlessSam edited this page Nov 10, 2022 · 5 revisions

As A CLI Tool

Pre-complied Binary

Each release of dfm comes with a CLI binary for Windows, Mac and Linux. Download the CLI file required for your operating system. Finally, make sure that the dfm binary is available on your PATH. This process will differ depending on your operating system.

Mac or Linux

Print a colon-separated list of locations in your PATH.

$ echo $PATH

Move the dfm binary to one of the listed locations. This command assumes that the binary is currently in your downloads folder and that your PATH includes /usr/local/bin, but you can customize it if your locations are different.

$ mv ~/Downloads/dfm-cli-mac /usr/local/bin/

For more detail about adding binaries to your path, see this Stack Overflow article.

Windows

This Stack Overflow article contains instructions for setting the PATH on Windows through the user interface.

Verify The Installation

Verify that the installation worked by opening a new terminal session and listing dfm's available subcommands.

$ dfm --help
usage: dfm-cli-mac [-h] [-p PARAMETERS] {merge,split} config_file_path

Merge files into a single file based on the rules defined in a config file.

positional arguments:
  {merge,split}
  config_file_path      The complete local path to the data-file-merge config
                        file.

options:
  -h, --help            show this help message and exit
  -p PARAMETERS, --parameters PARAMETERS
                        Key value pairs of parameters. E.g
                        "Key1=Value1,Key2=Value2..."

As a Python Package

Dfm is available on PyPi and can be installed via pip install data-file-merge

Clone this wiki locally