💻

Interacting with Components

The CLI allows you to interact with components on your Kodexa instance, you can list, get and deploy and delete components all from the command line.

In

we described the types of component, the CLI has the same command structure for each of these components.

All component commands work at the organization, therefore you always need to provide an organization.

The basic commands are:

List

You can list the components using the list component.

$ kodexa get stores my-org

Get a single component

You can get a single component by adding the rest of a ref to the last parameter. Optionally, you can include the version as well.

$ kodexa get stores my-org/my-store-ref

Deploy

You can list the components using the list component.

$ kodexa deploy --file my-component.yml

Delete

You can list the components using the list component.

$ kodexa delete stores my-org/my-store