@ixon-cdk/runner NPM

IXON Component Development Kit Runner

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

$ npx cdk <command>

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

$ npx cdk generate <component-name> [options]

$ npx cdk g <component-name> [options]

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

Option	Description	Value type
`--from-example`	Use a component example as a template.	`string`
`--config`	Path to the configuration file (e.g., ./my-config.json)	`string`

Builds the component

$ npx cdk build <component-name> [options]

$ npx cdk b <component-name> [options]

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

Option	Description	Value type	Default
`--compress`	Compress build output into a zip-file.	`boolean`	`false`
`--watch`	Run build when files change.	`boolean`	`false`
`--config`	Path to the configuration file (e.g., ./my-config.json)	`string`

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

$ npx cdk simulate <component-name>

$ npx cdk s <component-name>

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

Option	Description	Value type
`--config`	Path to the configuration file (e.g., ./my-config.json)	`string`

Deploys the component (authentication is required)

$ npx cdk deploy <component-name> [options]

$ npx cdk d <component-name> [options]

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

Option	Description	Value type	Default
`--publish`	Publishes the deployed component.	`boolean`	`false`
`--config`	Path to the configuration file (e.g., ./my-config.json)	`string`

Publish a deployed component (authentication is required)

$ npx cdk publish <component-name> [options]

$ npx cdk p <component-name> [options]

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

Option	Description	Value type	Default
`--version`	Publish the passed version number.	`string`
`--latest`	Publish the latest unpublished version	`boolean`	`false`
`--config`	Path to the configuration file (e.g., ./my-config.json)	`string`