CDK CLI Reference


tray-cdk version


Copy
Copied
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.

tray-cdk help [COMMANDS]


Display help for tray-cdk.

Copy
Copied
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.

tray-cdk autocomplete [SHELL]


display autocomplete installation instructions

Copy
Copied
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

tray-cdk init [CONNECTORNAME]


Initialize a connector project

Copy
Copied
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 add-operation [OPERATIONNAME] [OPERATIONTYPE]


Add an operation to connector project

Copy
Copied
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 test [OPERATIONNAME]


Build and test connector project or an operation

Copy
Copied
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 build


Builds a connector project

Copy
Copied
USAGE
  $ tray-cdk build

DESCRIPTION
  Builds a connector project

tray-cdk deploy


Deploys a connector project

Copy
Copied
USAGE
  $ tray-cdk deploy

DESCRIPTION
  Deploys a connector project