Introduction to Atlas

Atlas lets you connect your database, auto-generate a semantic layer, and query your data in plain English. Every query is validated, read-only access is enforced, and it deploys anywhere.

Getting Started

• Hosted Quick Start -- Sign up at app.useatlas.dev and start querying in minutes
• Self-Hosted Quick Start -- Deploy Atlas on your own infrastructure
• Connect Your Data -- Connect to PostgreSQL, MySQL, or plugin-based sources (ClickHouse, Snowflake, DuckDB, Salesforce)
• Semantic Layer -- Define your data schema in YAML so the agent understands your database
• Demo Datasets -- Try Atlas with pre-built demo data

Guides

• MCP Server -- Use Atlas in Claude Desktop, Cursor, and other MCP clients
• Slack Integration -- Query your data from Slack with slash commands and threaded follow-ups
• Python Data Analysis -- Sandboxed Python execution for charts and statistical analysis
• Scheduled Tasks -- Run recurring queries and deliver results via email, Slack, or webhook
• Actions Framework -- Approval-gated write operations (email, JIRA, and more)
• Admin Console -- Monitor connections, browse the semantic layer, and manage users
• Embedding Widget -- Add an Atlas chat widget to any website with a script tag
• Sharing Conversations -- Share conversations via public links and embed them
• Troubleshooting -- Diagnose and fix common issues

Deployment

• Deploy -- One-click deploy to Railway, Vercel, or Docker
• Authentication -- Configure auth modes: none, API key, managed, BYOT

Frameworks

• Bring Your Own Frontend -- Use Atlas with any frontend framework
• Framework-specific guides for React/Vite, Nuxt, SvelteKit, and TanStack Start

Security

• SQL Validation Pipeline -- 7-layer defense-in-depth for read-only SQL enforcement

Reference

• Environment Variables -- Complete env var reference with defaults
• CLI Reference -- All commands: init, diff, query, doctor, validate, mcp, and more
• Configuration -- Declarative config with atlas.config.ts
• SDK Reference -- TypeScript SDK for programmatic API access
• React Hooks Reference -- Headless React hooks for custom Atlas chat UIs
• API Reference -- HTTP API endpoints for chat, queries, and conversations

Plugins

• Plugin Authoring Guide -- Build datasource, context, interaction, action, and sandbox plugins

Architecture

• Sandbox Architecture -- Platform-agnostic code execution sandboxing design

Comparisons

• Atlas vs Alternatives -- Feature matrix comparing Atlas, WrenAI, Vanna, Metabase, Cube, and ThoughtSpot

Changelog

• Changelog -- What's new in Atlas