Documentation

Everything you need to master SQL2.AI for database development.

⌘K

Quick Start

Get up and running in under 5 minutes.

1

Install SQL2.AI

Install the CLI tool globally using npm or your preferred package manager.

Terminal
$npm install -g @sql2ai/cli
2

Configure Your Connection

Set up your database connection using the interactive configuration wizard.

Terminal
$sql2ai config init
SQL2.AI Configuration Wizard ? Database type: PostgreSQL ? Connection string: postgres://user@localhost/mydb ? Save connection as: dev ✓ Configuration saved to ~/.sql2ai/config.yaml
3

Run Your First Analysis

Analyze your database schema to discover issues and optimization opportunities.

Terminal
$sql2ai analyze --connection dev
Connecting to PostgreSQL... Analyzing schema... Schema Analysis Complete Tables: 23 | Views: 5 | Procedures: 12 ✓ All tables have primary keys ⚠ 2 tables missing foreign keys ⚠ 3 unused indexes detected ✓ Naming conventions: 98% compliant Full report saved to ./sql2ai-report.html
View Full Quick Start Guide

Browse Documentation

Find guides, references, and tutorials for every part of SQL2.AI.

Getting Started

Installation, configuration, and your first analysis.

CLI Reference

Complete command-line interface documentation.

MCP Integration

Using SQL2.AI with Claude and other AI assistants.

SDK & API

Programmatic access for custom integrations.

Features

Deep dives into each SQL2.AI capability.

Tutorials

Step-by-step guides for common workflows.

Database-Specific Guides

Detailed documentation for each supported database platform.

PG

PostgreSQL

Version 9.6 and above

  • Analyze PostgreSQL-specific features (CTEs, window functions)
  • Optimize EXPLAIN ANALYZE output
  • Generate native PL/pgSQL procedures
  • Index recommendations for JSONB columns
MS

SQL Server

Version 2016 and above

  • Parse execution plans with missing index hints
  • Optimize T-SQL stored procedures
  • Analyze columnstore index candidates
  • Support for temporal tables and CDC

Need Help?

Our community and support team are here to help you succeed.

GitHub Discussions

Ask questions and share ideas with the community.

Discord Community

Chat with developers and get real-time help.

Email Support

For paid plans, get direct email support.