CLI Overview

Syntax

dotnet Cinchy.CLI.dll <command> [options]

Global Command List

Command

Description

syncdata

Update a target dataset (e.g. a Cinchy table, a database table, etc.) with data from an input source (e.g. a delimited file, Salesforce, etc.) using a defined key to match records

exportdata

Exports the results of a query to a delimited file

matchdata

Matches data across sources to create a master record in Cinchy

appdiff

Generates a report outlining the differences between the physical implementation of an application across Cinchy environments

encrypt

Generates an encrypted string for use in other areas of the CLI

--version

Outputs the current version of the CLI

Dependencies

  1. You must have a compatible instance of Cinchy available for the CLI to connect to.

  2. The CLI runs using the .NET Core Framework, version 2.0.7+. The application can be compiled to a standalone executable for any of the target runtimes specified here.

  3. If using the syncdata or exportdata commands, then the CLI Model must be installed in your instance of Cinchy (see below).

CLI Model

The syncdata and exportdata commands depend upon the below Cinchy Model being installed in your Cinchy instance. Upon execution of these commands, a reference to the model name must be passed in.

Installation

To install the model in a new environment, follow the below instructions:

  1. Navigate to <your Cinchy instance url>/Apps/ModelLoader

  2. Choose the file and click Submit.

  3. Navigate back to the Models table within the Cinchy domain and locate the Name of the newly imported model. This name will be a parameter in the invocation of the CLI command.

If you want to have more than one instance of the model available in your Cinchy environment this is possible by changing the name on the root xml node prior to the import.

Model Overview

The model contains 3 tables:

  • Data Sync Configurations - XML configurations for use by the syncdata command are managed in this table.

  • Execution Log - Both the syncdata and exportdata commands log their executions in this table. This table captures the start time, end time, status, execution output, parameters, etc.

  • Execution Errors - Any exceptions occurring during the syncdata operation are logged in this table, with a reference back to the record in the Execution Log table. Depending on the granularity of the exception there may be row / column level details available.