@ixon-cdk/runner

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>

---

generate

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

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

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

Arguments

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

Options

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
--template	Name of the template to use (e.g. "Svelte"); this is mainly useful when automating component generation	string
--variant	Name of the variant to use (e.g. "TypeScript + SCSS"); this is mainly useful when automating component generation	string

---

build

Builds the component

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

$ npx cdk b <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
--config	Path to the configuration file (e.g., ./my-config.json)	string
--source-map	Generate source map for debugging purposes.	boolean	true

---

simulate

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

$ npx cdk simulate <component-name>

$ npx cdk s <component-name>

Arguments

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

---

deploy

Deploys the component (authentication is required)

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

$ npx cdk d <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
--config	Path to the configuration file (e.g., ./my-config.json)	string

---

publish

Publish a deployed component (authentication is required)

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

$ npx cdk p <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
--config	Path to the configuration file (e.g., ./my-config.json)	string

---

login

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

$ npx cdk login

---

logout

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

$ npx cdk logout