CLI Reference Overview

Complete reference for the Weik.io CLI commands

CLI Reference Overview

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

Getting Started

View available commands:

weikio --help

View help for any command:

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 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:

weikio integration flows ls
weikio agents ls
weikio users ls

Creating Resources

Create resources using add or create:

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

Deleting Resources

Delete resources using delete or del:

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

Viewing Details

View resource details using cat, view, or status:

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:

weikio i flows ls
weikio e get Customer cust-123

Profile Management

Connect to different Weik.io instances using profiles:

# 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:

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

Known Issues

See CLI Help Text Issues for a list of known issues in CLI help text.

Deprecated Commands

See Deprecated and Obsolete CLI Commands for commands related to deprecated features.