@trayio/cdk-cli

@trayio/cdk-cli

A collection of CLI commands for connector development.

Table of Contents

• @trayio/cdk-cli
• Table of Contents
• Usage
• Commands

Usage

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

Commands

• tray-cdk .
• tray-cdk autocomplete [SHELL]
• tray-cdk connector add-operation [OPERATIONNAME] [OPERATIONTYPE]
• tray-cdk connector build
• tray-cdk connector import [OPENAPISPEC] [CONNECTORNAME]
• tray-cdk connector init [CONNECTORNAME]
• tray-cdk connector test [OPERATIONNAME]
• tray-cdk deployment create
• tray-cdk deployment get [CONNECTORNAME] [CONNECTORVERSION] [UUID]
• tray-cdk help [COMMAND]
• tray-cdk permissions add [CONNECTORNAME] [CONNECTORVERSION]
• tray-cdk permissions list [CONNECTORNAME] [CONNECTORVERSION]
• tray-cdk plugins
• tray-cdk plugins add PLUGIN
• tray-cdk plugins:inspect PLUGIN...
• tray-cdk plugins install PLUGIN
• tray-cdk plugins link PATH
• tray-cdk plugins remove [PLUGIN]
• tray-cdk plugins reset
• tray-cdk plugins uninstall [PLUGIN]
• tray-cdk plugins unlink [PLUGIN]
• tray-cdk plugins update
• tray-cdk update [CHANNEL]
• tray-cdk version

tray-cdk .

USAGE
  $ tray-cdk .

tray-cdk autocomplete [SHELL]

Display autocomplete installation instructions.

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

ARGUMENTS
  SHELL  (zsh|bash|powershell) 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 powershell

  $ tray-cdk autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

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

Add an operation to connector project

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

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

DESCRIPTION
  Add an operation to connector project

tray-cdk connector build

Builds a connector project

USAGE
  $ tray-cdk connector build

DESCRIPTION
  Builds a connector project

tray-cdk connector import [OPENAPISPEC] [CONNECTORNAME]

Create a connector from an OpenAPI specification: Command is still in BETA

USAGE
  $ tray-cdk connector import [OPENAPISPEC] [CONNECTORNAME] [--skipInstall] [--skipLinting]

ARGUMENTS
  OPENAPISPEC    Location of the OpenAPI specification file
  CONNECTORNAME  The name of the connector

FLAGS
  --skipInstall  Skips NPM install after generating the connector, useful if you want to manually install dependencies
  --skipLinting  Skips linting after generating the connector, useful if you want to manually fix linting errors

DESCRIPTION
  Create a connector from an OpenAPI specification: Command is still in BETA

tray-cdk connector init [CONNECTORNAME]

Initialize a connector project

USAGE
  $ tray-cdk connector 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 connector test [OPERATIONNAME]

Build and test connector project or an operation

USAGE
  $ tray-cdk connector 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 deployment create

Creates a new deployment for a connector project

USAGE
  $ tray-cdk deployment create [--us] [--eu] [--ap]

FLAGS
  --ap  Use the Tray APAC region
  --eu  Use the Tray EU region
  --us  Use the Tray US region

DESCRIPTION
  Creates a new deployment for a connector project

tray-cdk deployment get [CONNECTORNAME] [CONNECTORVERSION] [UUID]

Retrieves the status of a connector deployment

USAGE
  $ tray-cdk deployment get [CONNECTORNAME] [CONNECTORVERSION] [UUID] [-t] [--us] [--eu] [--ap]

ARGUMENTS
  CONNECTORNAME     The name of the connector
  CONNECTORVERSION  The version of the connector
  UUID              The UUID of the deployment, this is included in the tray-cdk deploy output

FLAGS
  -t, --tail  Enables the command to run until the deployment is complete with either a success or failure.
      --ap    Use the Tray APAC region
      --eu    Use the Tray EU region
      --us    Use the Tray US region

DESCRIPTION
  Retrieves the status of a connector deployment

EXAMPLES
  $ tray-cdk deployment get

  $ tray-cdk deployment get --tail

  $ tray-cdk deployment get -t

  $ tray-cdk deployment get my-connector 1.0

  $ tray-cdk deployment get my-connector 1.0 --tail

  $ tray-cdk deployment get my-connector 1.0 -t

  $ tray-cdk deployment get my-connector 1.0 3f1de598-d405-4801-9eec-6fe79e8393d3

  $ tray-cdk deployment get my-connector 1.0 3f1de598-d405-4801-9eec-6fe79e8393d3 --tail

  $ tray-cdk deployment get my-connector 1.0 3f1de598-d405-4801-9eec-6fe79e8393d3 -t

tray-cdk help [COMMAND]

Display help for tray-cdk.

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

ARGUMENTS
  COMMAND  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 permissions add [CONNECTORNAME] [CONNECTORVERSION]

Share your connector version with other users in your organization

USAGE
  $ tray-cdk permissions add [CONNECTORNAME] [CONNECTORVERSION] [-e <value>] [--us] [--eu] [--ap]

ARGUMENTS
  CONNECTORNAME     The name of the connector
  CONNECTORVERSION  The version of the connector

FLAGS
  -e, --email=<value>  Share with users by providing a list of emails
      --ap             Use the Tray APAC region
      --eu             Use the Tray EU region
      --us             Use the Tray US region

DESCRIPTION
  Share your connector version with other users in your organization

EXAMPLES
  $ tray-cdk permissions add

  $ tray-cdk permissions add my-connector

  $ tray-cdk permissions add my-connector 1.0

  $ tray-cdk permissions add my-connector 1.0 --email="[e-mail], [e-mail]"

  $ tray-cdk permissions add my-connector 1.0 -e="[e-mail], [e-mail]"

tray-cdk permissions list [CONNECTORNAME] [CONNECTORVERSION]

Retrieves a list of emails that have access to a connector

USAGE
  $ tray-cdk permissions list [CONNECTORNAME] [CONNECTORVERSION] [--us] [--eu] [--ap]

ARGUMENTS
  CONNECTORNAME     The name of the connector
  CONNECTORVERSION  The version of the connector

FLAGS
  --ap  Use the Tray APAC region
  --eu  Use the Tray EU region
  --us  Use the Tray US region

DESCRIPTION
  Retrieves a list of emails that have access to a connector

EXAMPLES
  $ tray-cdk permissions list

  $ tray-cdk permissions list my-connector

  $ tray-cdk permissions list my-connector 1.0

tray-cdk plugins

List installed plugins.

USAGE
  $ tray-cdk plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ tray-cdk plugins

See code: @oclif/plugin-plugins

tray-cdk plugins add PLUGIN

Installs a plugin into tray-cdk.

USAGE
  $ tray-cdk plugins add PLUGIN [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into tray-cdk.

  Uses bundled npm executable to install plugins into ~/.local/share/@trayio/cdk-cli

  Installation of a user-installed plugin will override a core plugin.

  Use the TRAY_CDK_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the TRAY_CDK_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ tray-cdk plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ tray-cdk plugins add myplugin

  Install a plugin from a github url.

    $ tray-cdk plugins add https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ tray-cdk plugins add someuser/someplugin

tray-cdk plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ tray-cdk plugins inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ tray-cdk plugins inspect myplugin

See code: @oclif/plugin-plugins

tray-cdk plugins install PLUGIN

Installs a plugin into tray-cdk.

USAGE
  $ tray-cdk plugins install PLUGIN [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into tray-cdk.

  Uses bundled npm executable to install plugins into ~/.local/share/@trayio/cdk-cli

  Installation of a user-installed plugin will override a core plugin.

  Use the TRAY_CDK_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the TRAY_CDK_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ tray-cdk plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ tray-cdk plugins install myplugin

  Install a plugin from a github url.

    $ tray-cdk plugins install https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ tray-cdk plugins install someuser/someplugin

See code: @oclif/plugin-plugins

tray-cdk plugins link PATH

Links a plugin into the CLI for development.

USAGE
  $ tray-cdk plugins link PATH [-h] [--install] [-v]

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help          Show CLI help.
  -v, --verbose
      --[no-]install  Install dependencies after linking the plugin.

DESCRIPTION
  Links a plugin into the CLI for development.
  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.


EXAMPLES
  $ tray-cdk plugins link myplugin

See code: @oclif/plugin-plugins

tray-cdk plugins remove [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ tray-cdk plugins remove [PLUGIN] [-h] [-v]

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ tray-cdk plugins unlink
  $ tray-cdk plugins remove

EXAMPLES
  $ tray-cdk plugins remove myplugin

tray-cdk plugins reset

Remove all user-installed and linked plugins.

USAGE
  $ tray-cdk plugins reset [--hard] [--reinstall]

FLAGS
  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
  --reinstall  Reinstall all plugins after uninstalling.

See code: @oclif/plugin-plugins

tray-cdk plugins uninstall [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ tray-cdk plugins uninstall [PLUGIN] [-h] [-v]

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ tray-cdk plugins unlink
  $ tray-cdk plugins remove

EXAMPLES
  $ tray-cdk plugins uninstall myplugin

See code: @oclif/plugin-plugins

tray-cdk plugins unlink [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ tray-cdk plugins unlink [PLUGIN] [-h] [-v]

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ tray-cdk plugins unlink
  $ tray-cdk plugins remove

EXAMPLES
  $ tray-cdk plugins unlink myplugin

tray-cdk plugins update

Update installed plugins.

USAGE
  $ tray-cdk plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

tray-cdk update [CHANNEL]

update the tray-cdk CLI

USAGE
  $ tray-cdk update [CHANNEL] [-a] [--force] [-i | -v <value>]

FLAGS
  -a, --available        See available versions.
  -i, --interactive      Interactively select version to install. This is ignored if a channel is provided.
  -v, --version=<value>  Install a specific version.
      --force            Force a re-download of the requested version.

DESCRIPTION
  update the tray-cdk CLI

EXAMPLES
  Update to the stable channel:

    $ tray-cdk update stable

  Update to a specific version:

    $ tray-cdk update --version 1.0.0

  Interactively select version:

    $ tray-cdk update --interactive

  See available versions:

    $ tray-cdk update --available

See code: @oclif/plugin-update

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