@chili-publish/connector-cli
is a command-line interface tool designed to facilitate the management of connector test and publish processes in the CHILI publisher ecosystem. It provides a suite of commands to initialize projects, build connectors, debug, test, and publish them to the marketplace.
-
Initialize: Scaffold a new connector with
init
. -
Publish: Publish your connector to the marketplace with
publish
. -
Build: Build your connector from TypeScript to JavaScript with
build
. -
Debug: Run a local debug server for your connector with
debug
. -
Info: Retrieve information about your connector with
info
. -
Test: Run a test suite against your connector with
test
. -
Stress Test: Perform stress tests on your compiled connector with
stress
.
You can install @chili-publish/connector-cli
globally via npm:
npm install -g @chili-publish/connector-cli
Or, if you prefer using Yarn:
yarn global add @chili-publish/connector-cli
After installation, the connector-cli
command will be available globally. Below are some examples of how to use the CLI:
connector-cli init --name YourConnectorName
connector-cli build --outFolder ./dist
connector-cli publish pathToTsFile --baseUrl EnvironmentAPIBaseURL --environment YOUR_ENVIRONMENT --name YourConnectorName
connector-cli debug --port 8080 --watch
connector-cli info --out info.json
connector-cli test --testFile ./test/your-test-file.ts
connector-cli stress --iterations 100
To build @chili-publish/connector-cli
from source, follow these steps:
-
Clone the repository:
git clone https://github.com/chili-publish/studio-connector-contrib.git cd connector-cli
-
Install dependencies:
npm install
Or if you are using Yarn:
yarn install
-
Run the build script:
npm run build
Or with Yarn:
yarn build
This will compile TypeScript files to JavaScript and prepare the CLI for use.
Contributions are welcome! Please feel free to submit a pull request or create an issue if you have any ideas, suggestions, or bug reports.