Data Connector CLI

Purpose

This CLI tool was made to create and modify connector codebases. It also allows for easy distribution and deployments.

Usage

npx dcli <action>

We utilize NPX command line to run this CLI tool to stay up to date with the latest versions and updates with the CLI and other resources.

Installation

• Install Node's NPM packaging CLI tool which comes with npx.

Available action keywords

• create
• clone
• list
• update
• deploy
• help

The CLI tool is equipped with sub menus for easy usage and quick learning. Action Keywords are the CLI tools only argument when running the command. For example, if we wanted to CREATE a new connector we could run the command:

npx dcli create

Action Definitions

create

Creates a new codebase, repository location in both GitHub and AWS ECR. Sub-menus define the new connector and install the dependencies needed to develop a new Data Connector.

clone

Copies a connector onto your local development environment and installs all dependencies needed. You will need to enter in a connector name that you can get from the list action of the CLI.

list

Lists all available connectors

update

Updates connector to new version of the Data Connector API and updates versioning. This will not effect deploys until the command deploy is ran.

deploy

Submits a pull request to pull into Data Connectors list of connectors. Packages and updates dependencies needed to run connector.

help

Provides help topics on CLI commands and resources.