Integray.Connector.CLI 1.0.34

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 publishes it to the Integray repository.

For commands that interact with the Integray repository — such as publishing connectors or managing channels — a valid Integray API token and a publisher account are required. See the Authentication & Token handling section below for details on obtaining and configuring the token.

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.

The CLI is organized into domains, each responsible for a specific area of functionality.

General command structure:

integray <domain> <command> [options]

For detailed help on a specific area, run:

integray <domain>

Commands overview

Connector commands

Work with local connector projects.

• integray connector new - Scaffold a new connector project (including tests) from a template.
• integray connector pack - Build and package a connector project into a distributable ZIP file.
• integray connector publish - Publish a packaged connector ZIP to the Integray repository.

Channel commands

Manage repository channels (requires authentication).

• integray channel new - Create a new private channel.
• integray channel list - List channels accessible with the current token.
• integray channel delete - Delete a private channel.
• integray channel promote - Promote content from a private channel to a public channel.
• integray channel set - Set the active channel for the current solution (stored in .integray).
• integray channel current - Show the currently active channel for the current solution.
• integray channel clear - Clear the active channel for the current solution.

Entity commands

Browse and add entities from repository channels.

• integray entity list - List available entities (configurations and data schemas), with filtering options.
• integray entity add - Download an entity and add it to the connector project metadata.

Token commands

Manage authentication token on the local machine.

• integray token set - Store an Integray API token locally for automatic use.
• integray token delete - Remove the stored Integray API token.

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

You can choose from the following 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.

2) Implement your connector logic

Navigate to the newly created project directory, open it in your preferred IDE, and implement your connector logic.

cd ./MyCalculator

3) Build and package the connector:

integray connector pack

4) Store your Integray API token

Store your Integray API token locally so you don’t have to pass it on every command:

integray token set <TOKEN>

This is the recommended approach for local development.

The token will be securely stored on your machine and automatically used for all commands that require authentication. If you don’t have a token yet, see the Authentication & Token handling section below.

5) Select or create a PRIVATE development channel:

Before publishing, you need a PRIVATE channel to publish into.

1. List all channels available to your token:

   integray channel list
   

2. Choose an existing PRIVATE channel you want to use for development.
3. To set the active channel for the current solution, run:

integray channel set <CHANNEL_GUID>

If no suitable PRIVATE channel exists, create a new one:

integray channel new MyDevChannel

After the channel is created (or selected), the CLI will ask whether you want to set it as the active channel for the current solution. Confirm the prompt to store the channel in the local .integray configuration.

Once confirmed:

• the active channel is remembered for the solution
• you no longer need to specify the channel explicitly
• the stored token is used automatically

From this point on, you can publish connectors without passing --token or --channel on each command.

6) Publish the packaged ZIP to the Integray repository:

If you have an active channel and a stored authentication token, publishing is straightforward:

integray connector publish

The CLI will:

• use the last produced package from integray connector pack
• use the active channel stored in .integray
• use the stored token (or environment variable)

You can also publish explicitly by providing all parameters:

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

The last successfully built package is remembered automatically during integray connector pack and reused by default when no package path is provided.

7) Install the connector in Integray

After publishing the connector to your private channel, you need to make it available in Integray.

1. Open Integray in your browser
2. Navigate to Connector channels
3. Add your private channel (the one you published to)
4. Click Install all or run the Connector update job to install the connector from the channel.

Once installed, the connector becomes available for use in tasks.

Authentication & Token handling

Most commands that interact with the Integray repository (such as publishing connectors or managing channels) require an authentication token.

A valid Integray API token can be provided in one of the following ways (listed by priority):

1. Command-line option

Pass the token explicitly using the --token (or -t) option:

integray connector publish ./MyConnector.zip --channel <CHANNEL_ID> --token <TOKEN>

2. Environment variable

Set the token once using the INTEGRAY_TOKEN environment variable:

export INTEGRAY_TOKEN=<TOKEN>

On Windows (PowerShell):

setx INTEGRAY_TOKEN <TOKEN>

3. Local token storage (recommended)

integray token set <TOKEN>

Once stored, the token is used automatically and does not need to be provided again. If no token is available when required, the command will fail with a clear error message explaining how to provide one.

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.