CLI Reference Overview

Weik.io 2026.1

Complete reference for the Weik.io CLI commands.

On this page

Installation
Getting started
Command categories
Common command patterns
Command aliases
Profile management
Getting help

The Weik.io CLI provides command-line access to manage integrations, APIs, agents, and other platform resources.

Installation#

Linux/macOS:

Terminal

curl -fsSL https://weik.io/install-cli.sh | sh

Windows (PowerShell):

Terminal

irm https://weik.io/install-cli.ps1 | iex

After installation, add to your PATH:

Linux/macOS: export PATH="$PATH:$HOME/.weikio/bin"
Windows: $env:PATH += ";$env:USERPROFILE\.weikio\bin"

Verify installation:

Terminal

weikio --version

Getting started#

View available commands:

Terminal

weikio --help

View help for any command:

Terminal

weikio <command> --help
weikio <command> <subcommand> --help

Command categories#

Integration management#

integration: Manage integration flows, services, and MFTs
connector: Manage integration connectors

API management#

api: Manage APIs and API packages
endpoints: Manage API endpoints

Eventing#

channels: Manage event channels
subscriptions: Manage event subscriptions
eventdefinitions: Manage event definitions
eventsource: Manage event sources
eventsourceinstance: Manage event source instances
catalogs: Manage event source catalogs

Automation (deprecated)#

notebooks: Manage notebooks (deprecated)
actions: Manage actions (deprecated)
webjob: Manage WebJobs (deprecated)

Infrastructure#

agents: Manage agents
proxy: View proxy configuration
sandbox: Manage sandboxes

Configuration#

config: Apply configurations
profiles: Manage connection profiles
service: Manage services

Data management#

entities: Manage entities in the Entity Store

User management#

users: Manage users
apikey: Manage API keys

Utilities#

tools: CLI tools and utilities
version: Show CLI version

Common command patterns#

Listing resources#

Most commands support listing resources with the ls subcommand:

Terminal

weikio integration flows ls
weikio agents ls
weikio users ls

Creating resources#

Create resources using add or create:

Terminal

weikio users add john.doe
weikio integration flows create my-flow flow.yaml

Deleting resources#

Delete resources using delete or del:

Terminal

weikio users delete john.doe
weikio integration flows del my-flow

Viewing details#

View resource details using cat, view, or status:

Terminal

weikio integration flows cat my-flow
weikio integration flows status my-flow

Command aliases#

Some commands have shorter aliases:

integration → i
eventsource → es
eventsourceinstance → esi
eventdefinitions → ed
entities → e
configurations → config

Example:

Terminal

weikio i flows ls
weikio e get Customer cust-123

Profile management#

Connect to different Weik.io instances using profiles:

Terminal

# Add a profile
weikio profiles add production https://prod.example.com abc123key

# Switch profiles
weikio profiles change production

# List profiles
weikio profiles ls

Getting help#

Every command and subcommand supports the --help flag:

Terminal

weikio --help
weikio integration --help
weikio integration flows --help
weikio integration flows create --help