Installing CQLAI

CQLAI is distributed as a single static binary with no dependencies. Choose the installation method that works best for the target environment.

Quick Install

Using Go

With Go 1.21+ installed:

go install github.com/axonops/cqlai/cmd/cqlai@latest

Pre-compiled Binaries

Download the appropriate binary for your platform from GitHub Releases.

Linux (x86-64):

curl -L https://github.com/axonops/cqlai/releases/latest/download/cqlai-linux-amd64 -o cqlai
chmod +x cqlai
sudo mv cqlai /usr/local/bin/

Linux (ARM64):

curl -L https://github.com/axonops/cqlai/releases/latest/download/cqlai-linux-arm64 -o cqlai
chmod +x cqlai
sudo mv cqlai /usr/local/bin/

macOS (Intel):

curl -L https://github.com/axonops/cqlai/releases/latest/download/cqlai-darwin-amd64 -o cqlai
chmod +x cqlai
sudo mv cqlai /usr/local/bin/

macOS (Apple Silicon):

curl -L https://github.com/axonops/cqlai/releases/latest/download/cqlai-darwin-arm64 -o cqlai
chmod +x cqlai
sudo mv cqlai /usr/local/bin/

Windows: Download cqlai-windows-amd64.exe from the releases page and add it to your PATH.

---

Package Managers

APT (Debian/Ubuntu)

# Add AxonOps repository
curl -fsSL https://packages.axonops.com/gpg.key | sudo gpg --dearmor -o /usr/share/keyrings/axonops-archive-keyring.gpg
echo "deb [signed-by=/usr/share/keyrings/axonops-archive-keyring.gpg] https://packages.axonops.com/apt stable main" | sudo tee /etc/apt/sources.list.d/axonops.list

# Install CQLAI
sudo apt update
sudo apt install cqlai

YUM (RHEL/CentOS/Fedora)

# Add AxonOps repository
sudo tee /etc/yum.repos.d/axonops.repo << 'EOF'
[axonops]
name=AxonOps Repository
baseurl=https://packages.axonops.com/yum
enabled=1
gpgcheck=1
gpgkey=https://packages.axonops.com/gpg.key
EOF

# Install CQLAI
sudo yum install cqlai

Homebrew (macOS)

brew tap axonops/tap
brew install cqlai

---

Docker

Using Pre-built Image

# Pull the image
docker pull axonops/cqlai:latest

# Run interactively
docker run -it --rm axonops/cqlai --host your-cassandra-host

With Docker Compose

Add CQLAI to a Cassandra development environment:

version: '3.8'
services:
  cassandra:
    image: cassandra:5.0
    ports:
      - "9042:9042"

  cqlai:
    image: axonops/cqlai:latest
    depends_on:
      - cassandra
    command: ["--host", "cassandra"]
    stdin_open: true
    tty: true

Build from Source (Docker)

git clone https://github.com/axonops/cqlai.git
cd cqlai
docker build -t cqlai .
docker run -it --rm cqlai --host your-cassandra-host

---

Build from Source

Prerequisites

• Go 1.21 or later
• Git

Build Steps

# Clone the repository
git clone https://github.com/axonops/cqlai.git
cd cqlai

# Install dependencies
go mod download

# Build
go build -o cqlai cmd/cqlai/main.go

# Or use Make
make build

# Install to $GOPATH/bin
go install cmd/cqlai/main.go

Development Build

For development with race detection:

make build-dev

---

Verify Installation

# Check version
cqlai --version

# Show help
cqlai --help

# Test connection (requires running Cassandra)
cqlai --host 127.0.0.1

Expected output:

CQLAI v1.x.x
Modern CQL Shell for Apache Cassandra

---

Supported Platforms

Platform	Architecture	Status
Linux	x86-64 (amd64)	Supported
Linux	ARM64 (aarch64)	Supported
macOS	x86-64 (Intel)	Supported
macOS	ARM64 (Apple Silicon)	Supported
Windows	x86-64	Supported

---

Upgrading

Using Go

go install github.com/axonops/cqlai/cmd/cqlai@latest

Using Package Manager

# APT
sudo apt update && sudo apt upgrade cqlai

# YUM
sudo yum update cqlai

# Homebrew
brew upgrade cqlai

Manual Upgrade

Download the latest binary from releases and replace the existing binary.

---

Uninstalling

Go Installation

rm $(which cqlai)

Package Manager

# APT
sudo apt remove cqlai

# YUM
sudo yum remove cqlai

# Homebrew
brew uninstall cqlai

Configuration Files

CQLAI stores configuration in:

• ~/.cqlai.json - Main configuration
• ~/.cqlai/history - Command history
• ~/.cqlai/ai_history - AI command history

To fully remove:

rm -rf ~/.cqlai ~/.cqlai.json

---

Next Steps

After installation:

1. Quick Start Guide - Connect to Cassandra
2. Configuration - Set up connections and AI
3. Commands Reference - Learn available commands