@trayio/cdk-cli 0.2.0 → 0.4.0

package/INTRODUCTION.md

@@ -0,0 +1,54 @@
+# Connector Development Kit (CDK) CLI.
+
+The CDK Command Line Interface (CLI) is a tool that is aimed at simplifying connector development using the CDK, for a complete list of all commands refer to the [README](README.md)
+
+
+## Installing the CLI
+
+The CLI can be installed using npm:
+
+```
+npm install -g @trayio/cdk-cli
+```
+
+Once the installation is complete a `tray-cdk` command should be available.
+
+## Creating a connector
+
+To create a connector, the `init` command is used:
+
+```
+tray-cdk init -i
+```
+
+It will only ask for the connector name as input, the `-i` flag is optional, it is to install dependencies of the connector project using npm, but the flag can be omitted to install dependencies using another building tool such as yarn after creating the project.
+
+## Building and testing the connector
+
+When the connector project is created, it contains a sample operation that makes a request to a fake API, so it is recommended to build and test the connector after creating the project and installing the dependencies to make sure that the project builds properly and the runtime can execute operations.
+
+To build and test the connector using the cli, only one command is necessary:
+
+```
+tray-cdk test
+```
+
+This will compile the project and run all the tests, this command uses npm to run the compile and test scripts from the default `package.json`, which could be run without the cli using a different build tool, this may be preferable if the connector is a subproject in a monorepo for example.
+
+The test command can receive an operation name as an argument to test a single operation:
+
+```
+tray-cdk test my-operation
+```
+
+## Adding an operation
+
+The CLI can be used to add the skeleton of an operation, it is recommended to delete the operation created by the `init` command once it is verified that it works properly, and use the CLI to add new operations, as it will generate all the necessary files with the right names based on the new operation's name.
+
+To add an operation:
+
+```
+tray-cdk add-operation
+```
+
+It will ask for the operation's name, and for the operation's implementation, which can be HTTP or Composite, more details about these types of implementations can be found in the CDK DSL package.

package/README.md

@@ -24,7 +24,7 @@ $ npm install -g @trayio/cdk-cli
 $ tray-cdk COMMAND
 running command...
 $ tray-cdk (--version|-v)
-@trayio/cdk-cli/0.2.0 linux-x64 node-v18.17.0
+@trayio/cdk-cli/0.4.0 linux-x64 node-v18.17.0
 $ tray-cdk --help [COMMAND]
 USAGE
   $ tray-cdk COMMAND

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.2.0",
+  "version": "0.4.0",
   "commands": {
     "add-operation": {
       "id": "add-operation",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trayio/cdk-cli",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "A CLI for connector development",
   "exports": {
     "./*": "./dist/*.js"
@@ -32,7 +32,8 @@
   "files": [
     "/bin",
     "/dist",
-    "/oclif.manifest.json"
+    "/oclif.manifest.json",
+    "/INTRODUCTION.md"
   ],
   "bin": {
     "tray-cdk": "./bin/run"