Weik.io

Quickstart

Create and deploy your first integration in 5 minutes

Note: This quickstart focuses on developing and deploying your first integration using a pre-configured development environment. For production deployment and environment setup, see the Management section.

Prerequisites

You need:

  • VS Code installed
  • Docker installed and running

Launch Weik.io Environment

Open the development environment directly in VS Code:

Open in VS Code

The first time you launch the devcontainer, it will take a few minutes to build and start. Once complete, you’ll have:

  • A running Weik.io platform
  • The weikio CLI tool ready to use

Verify the Environment

Once the devcontainer starts, open a new terminal in VS Code (Terminal → New Terminal) and verify Weik.io is running:

weikio agents ls

You should see the Integration Agent running:

Verify Weik.io is running

Create Your First Integration

Weik.io integration flows are powered by Apache Camel, a powerful open-source integration framework.

Create an integrations directory and initialize a new integration:

mkdir -p integrations
cd integrations
weikio integration init my-first-integration

Output:

Integration initialized to my-first-integration/integration.camel.yaml
To run: weikio integration run my-first-integration

Check what was created:

ls -la my-first-integration

You’ll see two files:

-rw-r--r-- 1 user user  68 Nov 12 07:48 application.properties
-rw-r--r-- 1 user user 174 Nov 12 07:48 integration.camel.yaml

View the integration file:

cat my-first-integration/integration.camel.yaml

- from:
    uri: "timer:yaml"
    parameters:
      period: "3500"
    steps:
      - setBody:
          simple: "Hello Weik.io: {{AdditionalMessage}}"
      - log: "${body}"

This integration:

  • Runs every 3.5 seconds using a timer
  • Sets a message using a property from application.properties
  • Logs the message to the console

Visualize the Integration

The devcontainer includes the Karavan extension for VS Code, which provides a visual designer for integrations.

Right-click on my-first-integration/integration.camel.yaml and select Karavan: Open:

Open with Karavan

Karavan will visualize your integration flow:

Karavan editor showing the integration

You can see the timer source, transformation step, and log output in a visual diagram. Karavan allows you to edit integrations with drag-and-drop.

Test Locally

Run the integration on your local machine:

weikio integration run my-first-integration

You’ll see output like this:

Starting integration
11/12/2025 5:50:57 AM: Information: Apache Camel (JBang) 4.4.1 is starting
11/12/2025 5:50:58 AM: Information: Apache Camel 4.4.1 (my-first-integration) is starting
11/12/2025 5:50:58 AM: Information: Property-placeholders summary
11/12/2025 5:50:58 AM: Information:     [application.properties]       AdditionalMessage=This message comes from the application.properties
11/12/2025 5:50:58 AM: Information: Routes startup (started:1)
11/12/2025 5:50:58 AM: Information:     Started route1 (timer://yaml)
11/12/2025 5:50:58 AM: Information: Apache Camel 4.4.1 (my-first-integration) started in 152ms
Integration started successfully, press q to exit, s for stats
11/12/2025 5:50:59 AM: Information: Hello Weik.io: This message comes from the application.properties
11/12/2025 5:51:02 AM: Information: Hello Weik.io: This message comes from the application.properties
11/12/2025 5:51:06 AM: Information: Hello Weik.io: This message comes from the application.properties

The integration is now running! You’ll see the message logged every 3.5 seconds.

Press q to stop the integration.

Deploy to Weik.io

Push the integration to the Weik.io platform:

weikio integration push my-first-integration

You’ll see the integration configuration:

{
  "Name": "my-first-integration",
  "Project": "",
  "Variables": {
    "AdditionalMessage": "This message comes from the application.properties"
  },
  "Labels": [],
  "IntegrationFiles": [
    {
      "FileName": "integration.camel.yaml",
      "FileContent": "- from:\n    uri: \"timer:yaml\"..."
    },
    {
      "FileName": "application.properties",
      "FileContent": "AdditionalMessage=This message comes from the application.properties"
    }
  ],
  "Requirements": []
}

The integration is now deployed to Weik.io and ready to run on the platform.

Check Status

Verify the integration was deployed:

weikio integration flows ls

You’ll see your integration listed:

[
  {
    "FlowName": "my-first-integration",
    "Project": "",
    "Status": "Stopped",
    "RequestedStatus": 0,
    "RunningCount": 0,
    "ErrorCount": 0,
    "StoppedCount": 0,
    "UnknownCount": 0,
    "Category": "Flow",
    "AdditionalPackages": null,
    "Version": "1.0.0",
    "Labels": []
  }
]

The integration is deployed but not yet running (Status: “Stopped”).

Start the Integration

Start the integration on the Weik.io platform:

weikio integration flows start my-first-integration

Weik.io orchestrates the deployment and the Integration Agent will start running your integration.

Check the status again:

weikio integration flows ls

The status should now show “Running”:

[
  {
    "FlowName": "my-first-integration",
    "Project": "",
    "Status": "Running",
    "RequestedStatus": 1,
    "RunningCount": 1,
    "ErrorCount": 0,
    "StoppedCount": 0,
    "UnknownCount": 0,
    "Category": "Flow",
    "Version": "1.0.0",
    "Labels": []
  }
]

View in UI

Access the Weik.io web interface:

  1. In VS Code, open the Ports tab (usually at the bottom panel)
  2. Forward port 80 (the UI service)

Configure port forwarding

  1. Open your browser and navigate to the address shown in Forwarded Address (e.g., http://localhost:34089)
  2. Login with:

You’ll see the Weik.io dashboard with your integration:

Weik.io UI showing the integration

In the UI, you can:

  • See your integration running
  • View real-time logs
  • Monitor integration status
  • Manage integrations visually

Next Steps

You’ve created your first integration! Now explore more features: