You can use the Connect CLI via npm. Please note it's intended to be used with Constructor Connectors. If you don't have a Constructor Connector configured yet, please review our documentation to see how you can get started.

You will also need a connect auth token to authenticate with the Connect CLI. If you don't have your token yet, reach out to us at [email protected].

Initialize a new repository

When you initialize a new repository, the CLI will grab your company information from Constructor (such as a list of your indexes and configured connectors), and generate an initial repository to get you started.

You can initialize a new repository with:

npx @constructor-io/constructorio-connect-cli init YOUR_REPO_NAME

Upon doing so, this is what you'll see:

To recap:

1. Use the init command to create a new repository.
2. Enter the connect auth token, which will authenticate you with the connector ecosystem.

File structure

The repository will include starting templates you'll use to map and transform the data, fixtures to use as samples, and tests to validate the data transformations.

Please note that the data contained in these initial fixtures and the transformations within these initial templates are examples. You will need to generate new fixtures and update the templates to suit your integration.