@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
$ cdk COMMAND
running command...
$ cdk (--version|-v)
@trayio/cdk-cli/0.0.3 darwin-x64 node-v18.16.0
$ cdk --help [COMMAND]
USAGE
  $ cdk COMMAND
...

Commands

• cdk
• cdk autocomplete [SHELL]
• cdk connector:init
• cdk connector:operation:add
• cdk help [COMMANDS]
• cdk version

cdk

USAGE
  $ cdk

cdk autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ cdk autocomplete [SHELL] [-r]

ARGUMENTS
  SHELL  shell type

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

DESCRIPTION
  display autocomplete installation instructions

EXAMPLES
  $ cdk autocomplete

  $ cdk autocomplete bash

  $ cdk autocomplete zsh

  $ cdk autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

cdk connector:init

Initialize a connector project

USAGE
  $ cdk connector:init

DESCRIPTION
  Initialize a connector project

cdk connector:operation:add

Add an operation to connector project

USAGE
  $ cdk connector:operation:add

DESCRIPTION
  Add an operation to connector project

cdk help [COMMANDS]

Display help for cdk.

USAGE
  $ 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 cdk.

See code: @oclif/plugin-help

cdk version

USAGE
  $ 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