Install Kubiya CLI

This guide provides comprehensive instructions for installing, configuring, and setting up the Kubiya CLI on various platforms.

Installation Methods

Automatic Installation Script (Recommended)

The easiest way to install Kubiya CLI is using our automated installation script:

curl -fsSL https://cli.kubiya.ai/install | sh

This script will:

1. Detect your operating system and architecture

2. Download the appropriate binary

3. Install it to a suitable location in your PATH

4. Make it executable

5. Verify the installation

Manual Installation

If you prefer to install manually, follow these steps based on your operating system.

Step 1: Download the Appropriate Binary

Visit the Kubiya CLI Releases page and download the binary matching your system:

• MacOS (Intel): kubiya-cli-darwin-amd64

• MacOS (Apple Silicon): kubiya-cli-darwin-arm64

• Linux (x86_64): kubiya-cli-linux-amd64

• Linux (ARM64): kubiya-cli-linux-arm64

• Windows: kubiya-cli-windows-amd64.exe

Step 2: Make the Binary Executable and Move to PATH

For macOS/Linux:

# Navigate to download directory
cd ~/Downloads

# Make the binary executable
chmod +x kubiya-cli-*

# Move to a directory in your PATH
sudo mv kubiya-cli-* /usr/local/bin/kubiya

# For macOS, you may need to allow the binary
xattr -d com.apple.quarantine /usr/local/bin/kubiya

For Windows:

# Move the downloaded file to a location in your PATH, for example:
Move-Item -Path "$env:USERPROFILE\Downloads\kubiya-cli-windows-amd64.exe" -Destination "$env:USERPROFILE\AppData\Local\Microsoft\WindowsApps\kubiya.exe"

Installation via Package Managers

Homebrew (macOS and Linux)

brew tap kubiyabot/cli
brew install kubiya

Chocolatey (Windows)

choco install kubiya-cli

Initial Configuration

Setting Up Your API Key

After installing the CLI, you need to configure it with your Kubiya API key:

kubiya config set api-key YOUR_API_KEY

Replace YOUR_API_KEY with the API key from your Kubiya account. If you don't have an API key:

1. Log in to the Kubiya Dashboard
2. Navigate to Settings → API Keys

3. Create a new API key

4. Copy the key and use it in the command above

Verifying Your Installation

Verify that the CLI is properly installed and configured:

kubiya --version

This should display the current version of the Kubiya CLI.

To verify your API key configuration:

kubiya teammate list

If your API key is configured correctly, you should see a list of your teammates.

Configuring the CLI

The Kubiya CLI can be configured using the kubiya config command:

# View current configuration
kubiya config view

# Set configuration values
kubiya config set KEY VALUE

# Common configuration options
kubiya config set default-teammate "DevOps-Expert"  # Set default teammate for chat
kubiya config set default-format "json"             # Change default output format
kubiya config set debug true                        # Enable debug mode

Environment Variables

You can also configure the Kubiya CLI using environment variables:

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

# Set the API endpoint (for custom installations)
export KUBIYA_API_URL="https://api.custom-domain.com"

# Enable debug mode
export KUBIYA_DEBUG=true

Updating the CLI

To update to the latest version of the Kubiya CLI:

kubiya update

This will check for updates and install the latest version if available.

Troubleshooting Installation Issues

Common Issues and Solutions

1. Permission denied error:

   sudo chmod +x /usr/local/bin/kubiya

2. Command not found after installation:

   # Check if the binary is in PATH
   which kubiya
   
   # If not found, add the installation directory to PATH
   echo 'export PATH=$PATH:/usr/local/bin' >> ~/.bashrc
   source ~/.bashrc

3. MacOS security warnings: Go to System Preferences → Security & Privacy → General, and click "Allow Anyway", or use:

   xattr -d com.apple.quarantine /usr/local/bin/kubiya

4. API key issues:

   # Check if API key is set
   kubiya config view
   
   # Reset API key
   kubiya config set api-key YOUR_NEW_API_KEY

For further assistance, contact [e-mail] or visit our documentation.