connectif-importer

Command line interface to easily imports contacts or products csv file in Connectif Marketing Automation Platform.


Keywords
cli, connectif, import, products, contacts, marketing, csv
License
MIT
Install
npm install connectif-importer@1.1.0

Documentation

connectif-importer

Npm Version Actions Status CodeFactor codecov Dependabot Status JavaScript Style Guide Docker Pulls

A CLI to import your contacts and/or products to Connectif Marketing Automation Platform.

Installation

Install the NodeJs runtime.

Now, from your favorite shell, install the CLI by typing the following command:

$ npm install -g connectif-importer

Usage

The usage documentation can be found running the CLI with the help flag:

$ connectif-importer --help

Output:

Usage: connectif-importer [options]

Command line interface to easily imports contacts or products csv file in Connectif Marketing Automation Platform.

Options:
  -V, --version                output the version number
  -a, --apiKey <apiKey>        api key
  -d, --delimiter <delimiter>  csv delimiter (default: ",")
  -t, --type <type>            import type (contacts or products)
  -u, --updateOnlyEmptyFields  update only existing fields (default: false)
  -o, --overrideExisting       override contacts if existing (default: true)
  -f, --filePath <filePath>    csv file path
  -i, --interval <interval>    interval in milliseconds to check for import progress (default: 2000)
  -h, --help                   display help for command

Docker

In case you want to run the CLI using docker you can with the following commands:

The below will print the version of the CLI:

docker run --rm francescorivola/connectif-importer:latest

The below will run the CLI with the given options:

docker run --rm -v $(pwd)/file.csv:/home/node/file.csv francescorivola/connectif-importer:latest \
  --filePath=file.csv \
  --type=contacts \
  --apiKey=$CONNECTIF_API_KEY

License

MIT