Installing the CLI and the Maintenance CLI

Overview

The Command Line Interface (CLI) offers utilities to get data in and out of Cinchy.

The Maintenance CLI was formerly (prior to v5) packaged together with the CLI. It can be used to perform maintenance tasks such as data erasure and data compression deletions. For a full list of CLI commands, review the documentation here.

Deploying the CLI

  1. Navigate to the Cinchy Releases table and download the latest Cinchy Connections.zip file from the Release Artifacts column.

The Connections.zip file contains: Worker.zip, WebApi.zip, and CLI.zip.

2. Extract the CLI.zip.

3. Run the Cinchy.CLI.exe to deploy the CLI.

Deploying the Maintenance CLI

  1. Navigate to the Cinchy Releases table and download the latest Maintenance CLI.zip file from the Release Artifacts column.

  2. Extract the Maintenance CLI.zip.

  3. Run the Cinchy.Maintenance.CLI.exe to deploy the Maintenance CLI.

Last updated