Integration Commands

Manage integrations using the CLI

Manage integration flows, services, and related resources. The integration command can be shortened to i.

Usage

weikio integration [command] [options]
# or use the alias
weikio i [command] [options]

Subcommands

init

Initialize a new integration in a directory.

Usage:

weikio integration init <Name> [options]

Arguments:

Name	Required	Description
Name	Yes	Integration name

Options:

Flag	Description
-dir	Directory to initialize the integration in

Example:

weikio integration init my-integration -dir ./integrations

run

Run an integration locally for testing and development.

Usage:

weikio integration run <File> [options]

Arguments:

Name	Required	Description
File	Yes	File path of the integration

Options:

Flag	Description
-local-services-path, —ls	Path to local services

Example:

weikio integration run ./my-integration.yaml --ls ./services

push

Push an integration flow to the host.

Usage:

weikio integration push <Name> [options]

Arguments:

Name	Required	Description
Name	Yes	Name of the integration flow to push

Options:

Flag	Description
-category	Integration flow category
-variables	Variables file content to include in the integration flow
-deps	Additional packages loaded when running the integration flow
-add	Additional integration files for the integration flow
-labels	Integration flow labels
-requirements	WebJob requirements for the agents
-project	Project which includes the integration flow

Example:

weikio integration push my-integration -category "Data Sync" -project "Production"

design

Launch the local integration designer.

Usage:

weikio integration design [options]

Options:

Flag	Description
api-first	Enable API-first design mode

Example:

weikio integration design
weikio integration design api-first

flows

Manage integration flows on the host.

Usage:

weikio integration flows [command]

flows ls

List all integration flows.

Usage:

weikio integration flows ls

flows status

Get detailed status of an integration flow.

Usage:

weikio integration flows status <FlowId>

Arguments:

Name	Required	Description
FlowId	Yes	ID of the integration flow

flows view

View integration flow details.

Usage:

weikio integration flows view <FlowId>

Arguments:

Name	Required	Description
FlowId	Yes	ID of the integration flow

flows cat

Display integration flow contents.

Usage:

weikio integration flows cat <FlowId>

Arguments:

Name	Required	Description
FlowId	Yes	ID of the integration flow

flows create

Create an integration flow from a local file.

Usage:

weikio integration flows create <Name> <FileName>

Arguments:

Name	Required	Description
Name	Yes	Name for the integration flow
FileName	Yes	Path to the local file

flows update

Update an integration flow from a local file.

Usage:

weikio integration flows update <Name> <FileName>

Arguments:

Name	Required	Description
Name	Yes	Name of the integration flow to update
FileName	Yes	Path to the local file

flows start

Start an integration flow.

Usage:

weikio integration flows start <FlowId>

Arguments:

Name	Required	Description
FlowId	Yes	ID of the integration flow

flows stop

Stop an integration flow.

Usage:

weikio integration flows stop <FlowId>

Arguments:

Name	Required	Description
FlowId	Yes	ID of the integration flow

flows del

Delete an integration flow.

Usage:

weikio integration flows del <FlowId>

Arguments:

Name	Required	Description
FlowId	Yes	ID of the integration flow

mft

Manage managed file transfers.

Usage:

weikio integration mft [command]

mft ls

List all managed file transfers.

Usage:

weikio integration mft ls

mft status

Get detailed status of an MFT.

Usage:

weikio integration mft status <MftId>

Arguments:

Name	Required	Description
MftId	Yes	ID of the MFT

mft history

View MFT execution history.

Usage:

weikio integration mft history <MftId>

Arguments:

Name	Required	Description
MftId	Yes	ID of the MFT

mft start

Start an MFT.

Usage:

weikio integration mft start <MftId>

Arguments:

Name	Required	Description
MftId	Yes	ID of the MFT

mft stop

Stop an MFT.

Usage:

weikio integration mft stop <MftId>

Arguments:

Name	Required	Description
MftId	Yes	ID of the MFT

mft del

Delete an MFT.

Usage:

weikio integration mft del <MftId>

Arguments:

Name	Required	Description
MftId	Yes	ID of the MFT

mft cat

Display MFT configuration.

Usage:

weikio integration mft cat <MftId>

Arguments:

Name	Required	Description
MftId	Yes	ID of the MFT

services

Manage integration services.

Usage:

weikio integration services [command]

services ls

List all integration services.

Usage:

weikio integration services ls

services create

Create an integration service from a local file.

Usage:

weikio integration services create <FileName>

Arguments:

Name	Required	Description
FileName	Yes	Path to the local file

services update

Update an integration service from a local file.

Usage:

weikio integration services update <FileName>

Arguments:

Name	Required	Description
FileName	Yes	Path to the local file

services del

Delete an integration service.

Usage:

weikio integration services del <ServiceId>

Arguments:

Name	Required	Description
ServiceId	Yes	ID of the integration service

services cat

Display integration service contents.

Usage:

weikio integration services cat <ServiceId>

Arguments:

Name	Required	Description
ServiceId	Yes	ID of the integration service

coresystems

Manage core systems.

Usage:

weikio integration coresystems [command]

coresystems ls

List all core systems.

Usage:

weikio integration coresystems ls

coresystems cat

Display core system contents.

Usage:

weikio integration coresystems cat <SystemId>

Arguments:

Name	Required	Description
SystemId	Yes	ID of the core system

connector

Manage integration connectors. This is identical to the top-level weikio connector command.

Usage:

weikio integration connector openapi ls