CQLAI Quickstart
Get started with CQLAI in under 5 minutes.
Installation
Section titled “Installation”# Using Homebrewbrew install axonops/tap/cqlai
# Or download directlycurl -L https://github.com/axonops/cqlai/releases/latest/download/cqlai-darwin-arm64 -o cqlaichmod +x cqlaisudo mv cqlai /usr/local/bin/curl -L https://github.com/axonops/cqlai/releases/latest/download/cqlai-linux-amd64 -o cqlaichmod +x cqlaisudo mv cqlai /usr/local/bin/Verify Installation
Section titled “Verify Installation”cqlai --versionConnect to Cassandra
Section titled “Connect to Cassandra”Local Cassandra
Section titled “Local Cassandra”cqlaiRemote Cassandra
Section titled “Remote Cassandra”cqlai --host cassandra.example.comWith Authentication
Section titled “With Authentication”cqlai --host cassandra.example.com --username myuser --password mypasswordWith SSL
Section titled “With SSL”cqlai --host cassandra.example.com --sslBasic Usage
Section titled “Basic Usage”Execute CQL Queries
Section titled “Execute CQL Queries”cqlai> USE my_keyspace;cqlai:my_keyspace> SELECT * FROM users LIMIT 10;View Schema
Section titled “View Schema”-- List keyspacescqlai> DESCRIBE KEYSPACES;
-- Describe a tablecqlai> DESCRIBE TABLE my_keyspace.users;
-- Quick schema viewcqlai> .schemaUseful Commands
Section titled “Useful Commands”| Command | Description |
|---|---|
.help | Show available commands |
.schema | Show current schema |
.tables | List tables in current keyspace |
.clear | Clear the screen |
.exit | Exit CQLAI |
AI Query Generation (Optional)
Section titled “AI Query Generation (Optional)”Generate CQL queries from natural language descriptions.
Set up (Choose One Provider)
Section titled “Set up (Choose One Provider)”# OpenAIexport OPENAI_API_KEY=sk-...
# Anthropic Claudeexport ANTHROPIC_API_KEY=sk-ant-...
# Local Ollama (no API key needed)ollama serveGenerate Queries
Section titled “Generate Queries”cqlai> .ai show all users who signed up this week
Generated CQL: SELECT * FROM users WHERE created_at >= '2024-01-08' ALLOW FILTERING;
Execute? [Y/n]: yExport Data
Section titled “Export Data”To CSV
Section titled “To CSV”cqlai> .export users users.csvcqlai> .export users users.csv --format csvTo Parquet
Section titled “To Parquet”cqlai> .export users users.parquet --format parquetTo JSON
Section titled “To JSON”cqlai> .export users users.json --format jsonExport query results:
cqlai> .export "SELECT * FROM orders WHERE status = 'pending'" pending.csvConfiguration File
Section titled “Configuration File”Create a configuration file for persistent settings. CQLAI supports JSON format:
// ~/.config/cqlai/config.json (or ~/.cqlai.json or ./cqlai.json){ "host": "cassandra.example.com", "port": 9042, "username": "myuser", "ssl": { "enabled": true }, "ai": { "provider": "openai", "model": "gpt-4" }}See Configuration for all available options.
Next Steps
Section titled “Next Steps”- Full Installation Guide - Detailed installation options
- Configuration - All configuration options
- AI Features - AI provider setup and usage
- Commands Reference - Complete command reference
- Troubleshooting - Common issues and solutions