@trayio/cdk-cli

@trayio/connector-cli

A collection of CLI commands for connector development.

Contributing

Guide on contributing

Table of Contents

• @trayio/connector-cli
• Contributing
• Table of Contents
• Usage
• Commands

Usage

$ npm install -g @trayio/cdk-cli
$ tray-cdk COMMAND
running command...
$ tray-cdk (--version|-v)
@trayio/cdk-cli/0.7.0 linux-x64 node-v18.17.1
$ tray-cdk --help [COMMAND]
USAGE
  $ tray-cdk COMMAND
...

Commands

• tray-cdk
• tray-cdk add-operation [OPERATIONNAME] [OPERATIONTYPE]
• tray-cdk autocomplete [SHELL]
• tray-cdk help [COMMANDS]
• tray-cdk init [CONNECTORNAME]
• tray-cdk test [OPERATIONNAME]
• tray-cdk version

tray-cdk

USAGE
  $ tray-cdk

tray-cdk add-operation [OPERATIONNAME] [OPERATIONTYPE]

Add an operation to connector project

USAGE
  $ tray-cdk add-operation [OPERATIONNAME] [OPERATIONTYPE]

ARGUMENTS
  OPERATIONNAME  Operation name
  OPERATIONTYPE  (http|composite) Operation type

DESCRIPTION
  Add an operation to connector project

tray-cdk autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ tray-cdk autocomplete [SHELL] [-r]

ARGUMENTS
  SHELL  shell type

FLAGS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

DESCRIPTION
  display autocomplete installation instructions

EXAMPLES
  $ tray-cdk autocomplete

  $ tray-cdk autocomplete bash

  $ tray-cdk autocomplete zsh

  $ tray-cdk autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

tray-cdk help [COMMANDS]

Display help for tray-cdk.

USAGE
  $ tray-cdk help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for tray-cdk.

See code: @oclif/plugin-help

tray-cdk init [CONNECTORNAME]

Initialize a connector project

USAGE
  $ tray-cdk init [CONNECTORNAME] [-i]

ARGUMENTS
  CONNECTORNAME  Connector directory name to generate template files

FLAGS
  -i, --install  Runs `npm install` after successful generation

DESCRIPTION
  Initialize a connector project

tray-cdk test [OPERATIONNAME]

Build and test connector project or an operation

USAGE
  $ tray-cdk test [OPERATIONNAME] [-v]

ARGUMENTS
  OPERATIONNAME  Operation name to run the test against

FLAGS
  -v, --verbose  Logs the input and output of an operation, requires operation name argument to be specified

DESCRIPTION
  Build and test connector project or an operation

tray-cdk version

USAGE
  $ tray-cdk version [--json] [--verbose]

FLAGS
  --verbose  Show additional information about the CLI.

GLOBAL FLAGS
  --json  Format output as json.

FLAG DESCRIPTIONS
  --verbose  Show additional information about the CLI.

    Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.

See code: @oclif/plugin-version