llms.txt
Compare with other sites' llms.txt files →# ClickHouse
> ClickHouse is an open-source, column-oriented database (OLAP) for real-time analytics. ClickHouse Cloud is the fully managed service for ClickHouse and Postgres, with a free trial.
Use this index to find machine-readable documentation and resources. Follow the linked indexes when you need individual pages.
## When to use ClickHouse
- [Real-time analytics](https://clickhouse.com/use-cases/real-time-analytics): Aggregations over billions of rows in milliseconds, for dashboards, user-facing analytics and APIs.
- [Observability with ClickStack](https://clickhouse.com/clickstack): Open-source logs, metrics, traces and session replay on OpenTelemetry, ClickHouse and HyperDX. Also [managed in ClickHouse Cloud](https://clickhouse.com/cloud/clickstack).
- [Data warehousing](https://clickhouse.com/use-cases/data-warehousing): Fast BI and reporting queries at a fraction of the cost.
- [Machine learning and GenAI](https://clickhouse.com/use-cases/machine-learning-and-data-science): Real-time data for machine learning workloads and GenAI on analytics data.
- [AI and agents](https://clickhouse.com/ai): The Agentic Data Stack: ClickHouse, the ClickHouse MCP server, LibreChat and Langfuse, for agentic analytics on real-time data.
- [Postgres managed by ClickHouse](https://clickhouse.com/cloud/postgres): Managed Postgres (beta) integrated with ClickHouse: Postgres for transactions, ClickHouse for analytics.
- [chDB](https://clickhouse.com/chdb): ClickHouse as an in-process SQL engine inside Python and other languages, with no server.
- [ClickHouse Cloud](https://clickhouse.com/cloud): Fully managed ClickHouse and Postgres on AWS, Google Cloud and Azure, or [in your own cloud account](https://clickhouse.com/cloud/bring-your-own-cloud). [ClickPipes](https://clickhouse.com/cloud/clickpipes) handles managed ingestion.
## How agents should use ClickHouse
- For research, fetch the documentation index below and follow its links. Documentation pages are available as Markdown at their URL plus `.md`.
- Use the ClickHouse CLI, `clickhousectl`, for both local and Cloud work. Install it with `curl https://clickhouse.com/cli | sh`.
- For local development, run ClickHouse with `clickhousectl local`.
- For ClickHouse Cloud, authenticate with `clickhousectl cloud auth login` (an API key for read/write, or the OAuth device flow for read-only), then manage services with `clickhousectl cloud service …`. If needed, fall back to the Cloud API using its [OpenAPI description](https://api.clickhouse.cloud/v1). Ask for approval before creating, changing or deleting services.
- For the remote MCP servers, use an OAuth-capable MCP client and let the user authorize access to their ClickHouse Cloud organization. Use a Cloud API key only for headless use.
## Agent setup
- [ClickHouse getting-started skill](https://clickhouse.com/SKILL.md): What ClickHouse is, and how to install, run and query it locally and in ClickHouse Cloud with clickhousectl.
- [ClickHouse agent skills](https://github.com/ClickHouse/agent-skills): Official skills for coding agents (best practices, architecture, chDB, ClickStack, Node.js client and more). Install with `clickhousectl skills`.
- [ClickHouse CLI reference](https://clickhouse.com/docs/products/cloud/features/cli.md): `clickhousectl` commands for local servers, Cloud services, Postgres and ClickPipes.
- [ClickHouse Cloud remote MCP server](https://clickhouse.com/docs/products/cloud/features/ai-ml/mcp/remote-mcp.md): Endpoint https://mcp.clickhouse.cloud/mcp. Query and explore Cloud services; OAuth per user, or a Cloud API key for headless use.
- [Managed ClickStack MCP server](https://mcp.clickhouse.cloud/clickstack): Remote MCP server for logs, traces and metrics in Managed ClickStack. OAuth.
- [ClickHouse Docs MCP server](https://clickhouse.com/docs/mcp): Public MCP server for searching the documentation. No authentication.
- [MCP discovery](https://clickhouse.com/.well-known/mcp): All ClickHouse MCP servers, with their server cards.
- [Agent authentication](https://clickhouse.com/auth.md): How agents get and use credentials for the MCP servers, the Cloud API and database services.
- [mcp-clickhouse](https://github.com/ClickHouse/mcp-clickhouse): Open-source MCP server to run yourself against any ClickHouse.
- Repositories with agent instructions (AGENTS.md): [ClickHouse](https://github.com/ClickHouse/ClickHouse), [mcp-clickhouse](https://github.com/ClickHouse/mcp-clickhouse), [clickhousectl](https://github.com/ClickHouse/clickhousectl), [agent-skills](https://github.com/ClickHouse/agent-skills).
## Documentation
- [Documentation index](https://clickhouse.com/docs/llms.txt): Every documentation page as a Markdown link, grouped into database, solutions, integrations and resources.
- [Full documentation content](https://clickhouse.com/docs/llms-full.txt): The complete documentation in one file.
- [Installation](https://clickhouse.com/docs/get-started/setup/install.md): ClickHouse Cloud and self-managed install options, including the single-binary `curl https://clickhouse.com/ | sh`.
- [ClickHouse Cloud quick start](https://clickhouse.com/docs/get-started/setup/cloud.md): Provision a service, connect and load data from the command line with clickhousectl.
## Cloud API and developer resources
- [ClickHouse Cloud API](https://clickhouse.com/docs/products/cloud/features/admin-features/api/api-overview.md): REST API for organizations, services, API keys and members.
- [Cloud API OpenAPI description](https://api.clickhouse.cloud/v1): Machine-readable OpenAPI 3.1 description of the Cloud API.
- [Cloud API keys](https://clickhouse.com/docs/products/cloud/features/admin-features/api/openapi.md): Create API keys and use them with the Cloud API, the CLI and the remote MCP server.
- [API catalog](https://clickhouse.com/.well-known/api-catalog): RFC 9727 catalog of public APIs.
## Self-serve onboarding
- [Sign up for ClickHouse Cloud](https://console.clickhouse.cloud/signUp): Free trial with $300 in credits for 30 days. From a terminal: `clickhousectl cloud auth signup`.
- [Pricing](https://clickhouse.com/pricing.md): Plans, trial terms and per-region compute and storage rates, in Markdown.
- [Startup program](https://clickhouse.com/startup-offer): Founders can apply for ClickHouse Cloud credits.
## Site indexes
- [ClickHouse site pages](https://clickhouse.com/pages/llms.txt): Product, use case, industry, company, partner and event pages
- [ClickHouse Blog](https://clickhouse.com/blog/llms.txt): Blog posts from the last six months, with summaries
- [ClickHouse Engineering Resources](https://clickhouse.com/resources/llms.txt): Engineering guides and explainers
- [ClickHouse Videos](https://clickhouse.com/videos/llms.txt): Customer testimonials, tutorials and talks
- [ClickHouse comparisons and migrations](https://clickhouse.com/comparison/llms.txt): ClickHouse compared with Snowflake, BigQuery, Redshift, Postgres, Datadog, Elastic and others
- [ClickHouse integrations](https://clickhouse.com/integrations/llms.txt): Language clients, ingestion, BI and data tools
- [ClickHouse legal](https://clickhouse.com/legal/llms.txt): Terms, agreements, privacy and security policies
## Optional
- [Agent resource catalog](https://clickhouse.com/.well-known/ai-catalog.json): Skills and other agent-facing resources.
- [MCP server catalog](https://clickhouse.com/.well-known/mcp/catalog.json): Server cards for the remote MCP servers.
- [Agent skills index](https://clickhouse.com/.well-known/agent-skills/index.json): Downloadable agent skill archives.
- [Sitemap](https://clickhouse.com/sitemap.xml): Every public URL on clickhouse.com.
- [Blog RSS feed](https://clickhouse.com/rss.xml): Latest blog posts.