Skip to main content
The Kubiya CLI is a comprehensive command-line interface that empowers you to build, deploy, and manage AI-powered automation workflows from your terminal. Whether you’re managing infrastructure, orchestrating agents, or executing complex workflows, the CLI provides full control over the Kubiya platform.

​
What is the Kubiya CLI?

The Kubiya CLI is a powerful tool that enables developers and DevOps engineers to:
  • Manage Control Plane Resources: Create and configure agents, teams, projects, and environments
  • Run Workers: Deploy and manage Temporal-based execution engines on your infrastructure
  • Execute Workflows: Run automated workflows from local files, Git repositories, or URLs
  • Orchestrate Tools: Execute and manage tools with full integration support
  • Control Resources: Manage sources, secrets, runners, and webhooks
  • Chat with Agents: Interact with AI agents directly from your terminal

​
Key Capabilities

Worker Management

Deploy and manage Temporal workers for executing agent workflows with enterprise-grade reliability

Resource Control

Full CRUD operations for agents, teams, sources, tools, secrets, and runners

Workflow Execution

Execute workflows from multiple sources with real-time tracking and GitHub authentication

Agent Interaction

Chat with AI agents, provide context, and execute tasks from your terminal

​
Architecture

The Kubiya CLI integrates seamlessly with the Kubiya platform architecture:

​
Core Components

  1. Control Plane Integration
    • Authenticate with API keys
    • Manage all platform resources
    • Configure environments and policies
  2. Worker Management
    • Start local, Docker, or Kubernetes workers
    • Monitor worker health and logs
    • Configure execution environments
  3. Resource Operations
    • Create and manage agents
    • Configure tools and sources
    • Handle secrets and integrations
  4. Workflow Execution
    • Execute from local files or Git repositories
    • Real-time progress tracking
    • Variable substitution and parameter passing

​
Common Use Cases

​
Infrastructure Management

# Deploy workers on your infrastructure
kubiya worker start --queue-id=prod-queue --type=local

# Execute infrastructure automation
kubiya workflow execute myorg/infra-workflows/provision.yaml

​
Agent Operations

# Create an agent
kubiya agent create --name "DevOps Agent" --desc "Handles automation tasks"

# Chat with an agent
kubiya chat -n "DevOps Agent" -m "Deploy to staging"

​
Development Workflow

# Scan and add tools from your repository
kubiya source scan . --force
kubiya source add . --name "My Tools"

# Test tool execution
kubiya tool exec --name "deploy-script" --content "./deploy.sh"

​
CI/CD Integration

# Execute deployment workflow from GitHub Actions
kubiya workflow execute myorg/workflows/deploy.yaml \
  --var environment=production \
  --var version=${{ github.sha }}

​
Platform Integration

The CLI provides complete access to Kubiya platform features:
  • Control Plane: Full API access to all control plane resources
  • Worker Queues: Manage distributed task execution
  • Context Graph: Query and utilize organizational knowledge
  • Policies: Enforce OPA-based governance
  • Analytics: Monitor execution metrics and performance

​
Getting Started

Ready to start using the Kubiya CLI? Follow these guides:

Installation

Install the CLI on macOS, Linux, or from source

Authentication

Configure API keys and connect to the control plane

Worker Setup

Deploy your first worker and start executing tasks

Resource Management

Learn to manage agents, tools, and other resources

​
Quick Reference

​
Installation

# macOS
brew install kubiyabot/kubiya/kubiya

# Linux
curl -fsSL https://raw.githubusercontent.com/kubiyabot/cli/main/install.sh | bash

​
Configuration

# Set API key
export KUBIYA_API_KEY="your-api-key"

# Verify installation
kubiya agent list

​
Common Commands

# Start a worker
kubiya worker start --queue-id=my-queue --type=local

# Execute a workflow
kubiya workflow execute deployment.yaml

# Chat with an agent
kubiya chat -n "Agent Name" -m "your message"

# List resources
kubiya agent list
kubiya tool list
kubiya source list

​
Next Steps

Installation Guide

Install and verify the CLI

Worker Management

Deploy and manage workers

Workflow Execution

Execute automated workflows

Agent Management

Create and manage agents

Resource Control

Manage tools, sources, and secrets

Advanced Features

Webhooks and integrations