yot-cdk-runner

Component Development Kit Runner

This is the main entrypoint of the Component Development Kit (CDK). It contains logic to run commands in a CDK workspace.

$ node ./node_modules/yot-cdk-runner <command>

generate

Prompts the user to generate a new component based on a template.

$ node ./node_modules/yot-cdk-runner generate

build

Builds the component

$ node ./node_modules/yot-cdk-runner build <component-name> [options]

Arguments

Argument	Description	Value type
<component-name>	The name of the component to build.	string

Options

Option	Description	Value type	Default
--compress	Compress build output into a zip-file.	boolean	false
--watch	Run build when files change.	boolean	false

simulate

Builds the component (in watch-mode) and runs it inside the simulator.

$ node ./node_modules/yot-cdk-runner simulate <component-name>

Arguments

Argument	Description	Value type
<component-name>	The name of the component to build.	string

deploy

Deploys the component (authentication is required)

$ node ./node_modules/yot-cdk-runner deploy <component-name> [options]

Arguments

Argument	Description	Value type
<component-name>	The name of the component to deploy.	string

Options

Option	Description	Value type	Default
--publish	Publishes the deployed component.	boolean	false

publish

Publish a deployed component (authentication is required)

$ node ./node_modules/yot-cdk-runner publish <component-name> [options]

Arguments

Argument	Description	Value type
<component-name>	The name of the component to publish.	string

Options

Option	Description	Value type	Default
--version	Publish the passed version number.	string
--latest	Publish the latest unpublished version	boolean	false

login

Log in with your user account credentials. Generates a .accesstoken file.

$ node ./node_modules/yot-cdk-runner login

logout

Logs out. Removes the .accesstoken file that was generated on login.

$ node ./node_modules/yot-cdk-runner logout