Integray.Connector.CLI 1.0.26

Integray Connector CLI

Create, package, and publish connectors with the Integray Connector CLI — a small command-line tool designed for the Integray integration platform (see Integray). The tool quickly generates a connector project from a template, builds it into a ZIP package, and can publish it to the Integray repository.

Install / Upgrade / Uninstall

Install globally:

dotnet tool install -g Integray.Connector.CLI

Upgrade to latest:

dotnet tool update -g Integray.Connector.CLI

Uninstall:

dotnet tool uninstall -g Integray.Connector.CLI

Requirements: .NET SDK 6.0 must be installed and available on your PATH. Network access is required only for publishing the connector.

Getting started

After installing the tool, the global command integray will be available.

Command structure: integray connector <command> [options]

Commands overview

• integray connector new — scaffold a new connector project + tests from a template.
• integray connector pack — build and package an existing connector project into a distributable ZIP.
• integray connector publish — publish a packaged connector ZIP to the Integray repository.

Example workflow

A short example showing the typical steps to create, package and publish a connector for Integray.

1. Create a new connector from a template:

integray connector new --template Calculator --name MyCalculator ./MyCalculator

2. Build and package the connector:

integray connector pack -p ./MyCalculator/Integray.Connector.MyCalculator.csproj -o ./dist/MyCalculator.zip

3. Publish the packaged ZIP to the Integray repository:

integray connector publish --source ./dist/MyCalculator.zip --channel <CHANNEL_ID> --token <TOKEN>

integray connector new

Scaffold a new connector project (connector itself + tests) from a selected template.

Usage:

integray connector new --template <Template> --name <Name> <OutputDirectory>

Or with short flags:

integray connector new -t <Template> -n <Name> <OutputDirectory>

Options:

• --template, -t Required. Template name (e.g. Calculator). See Available templates below.
• --name, -n Required. Connector name without spaces (e.g. MyCalculatorConnector).
• <OutputDirectory> Required. Destination folder for generated projects.

Example:

integray connector new --template Calculator --name MyCalculator ./MyCalculator

Example (short flags):

integray connector new -t Calculator -n MyCalculator ./MyCalculator

Available templates

• Calculator — Demonstrates the use of input and output data, configurations and logging.
• Empty — Minimal connector template without any data or configurations.
• GitHub — Demonstrates how to call a public REST API, retrieve and parse output data.

integray connector pack

Build and package an existing connector project into a distributable ZIP.

Usage:

integray connector pack --project <PathToCsproj> --output <ZipPath>

Or with short flags:

integray connector pack -p <PathToCsproj> -o <ZipPath>

Options:

• --project, -p Required. Path to the connector .csproj.
• --output, -o Required. Path to the resulting zip archive.

What it does:

• Runs dotnet build for net6.0 in Release configuration.
• Zips build output as plugin.zip and embeds it into the final archive.
• Includes files from the project's Metadata/ directory at the root of the final archive.

Example:

integray connector pack --project ./MyCalculator/Integray.Connector.MyCalculator.csproj --output ./dist/MyCalculator.zip

Example (short flags):

integray connector pack -p ./MyCalculator/Integray.Connector.MyCalculator.csproj -o ./dist/MyCalculator.zip

integray connector publish

Publish a packaged connector ZIP to the Integray repository. Publishing requires a publisher account that allows you to create and manage channels, upload packages and control releases — to request access, contact support@integray.com.

Usage:

integray connector publish <package> --channel <ChannelId> --token <Token>

Or with short flags:

integray connector publish <package> -c <ChannelId> -t <Token>

Positional arguments:

• package (pos. 0) Required. Path to the ZIP package produced by integray connector pack (e.g. ./dist/MyCalculator.zip).

Options:

• --channel, -c Required. Identifier of the channel to publish to.
• --token, -t Required. Bearer token used for authentication.

Example:

integray connector publish ./NewConnector.zip -c b5f1a1a6-0e6d-4b49-a7e4-746cfe7f6f7b -t 2d8c73df-f6d5-4d0d-936a-9c54b91a4d13

Short form example:

integray connector publish ./NewConnector.zip -c b5f1a1a6-0e6d-4b49-a7e4-746cfe7f6f7b -t 2d8c73df-f6d5-4d0d-936a-9c54b91a4d13

If you need a publishing channel or a publisher account to manage your channels, please contact support@integray.com. A publisher account is required to create channels and publish packages.