clickhousectl docs

docs/cloud/features/02b_cli.md

@@ -0,0 +1,113 @@
+---
+sidebar_label: 'ClickHouse CLI'
+slug: /cloud/features/cli
+title: 'ClickHouse CLI'
+description: 'Use the ClickHouse CLI to manage ClickHouse Cloud services and local ClickHouse instances'
+keywords: ['clickhousectl', 'CLI', 'cloud management', 'local development']
+doc_type: 'reference'
+---
+
+# ClickHouse CLI {#clickhouse-cli}
+
+The ClickHouse CLI (`clickhousectl`) is a unified command-line tool for managing ClickHouse Cloud resources, and local development with ClickHouse.
+
+## Installation {#installation}
+
+```bash
+curl https://clickhouse.com/cli | sh
+```
+
+A `chctl` alias is also created automatically for convenience.
+
+## Cloud management {#cloud-management}
+
+Authenticate with ClickHouse Cloud and manage your services directly from the command line.
+
+### Authentication {#authentication}
+
+```bash
+clickhousectl cloud auth
+```
+
+This prompts for your API key and secret, and saves them to `.clickhouse/credentials.json` (project-local, git-ignored).
+
+You can also use environment variables:
+
+```bash
+export CLICKHOUSE_CLOUD_API_KEY=your-key
+export CLICKHOUSE_CLOUD_API_SECRET=your-secret
+```
+
+### Services {#services}
+
+```bash
+# List services
+clickhousectl cloud service list
+
+# Create a service
+clickhousectl cloud service create --name my-service \
+  --provider aws \
+  --region us-east-1
+
+# Get service details
+clickhousectl cloud service get <service-id>
+
+# Scale a service
+clickhousectl cloud service scale <service-id> \
+  --min-replica-memory-gb 24 \
+  --max-replica-memory-gb 48 \
+  --num-replicas 3
+
+# Start/stop a service
+clickhousectl cloud service start <service-id>
+clickhousectl cloud service stop <service-id>
+
+# Delete a service
+clickhousectl cloud service delete <service-id>
+```
+
+### Organizations {#organizations}
+
+```bash
+clickhousectl cloud org list
+clickhousectl cloud org get <org-id>
+```
+
+### API keys {#api-keys}
+
+```bash
+clickhousectl cloud key list
+clickhousectl cloud key create --name ci-key --role-id <role-id>
+clickhousectl cloud key delete <key-id>
+```
+
+### Members and invitations {#members-and-invitations}
+
+```bash
+clickhousectl cloud member list
+clickhousectl cloud invitation create --email dev@example.com --role-id <role-id>
+```
+
+### Backups {#backups}
+
+```bash
+clickhousectl cloud backup list <service-id>
+clickhousectl cloud backup get <service-id> <backup-id>
+```
+
+### JSON output {#json-output}
+
+Use the `--json` flag to get JSON-formatted responses from any cloud command:
+
+```bash
+clickhousectl cloud --json service list
+```
+
+## Local development {#local-development}
+
+The CLI also manages local ClickHouse installations and servers. See the [quick install](/install/quick-install) page for getting started with local development.
+
+## Requirements {#requirements}
+
+- macOS (aarch64, x86_64) or Linux (aarch64, x86_64)
+- Cloud commands require a [ClickHouse Cloud API key](/cloud/manage/openapi)

docs/cloud/onboard/01_discover/01_what_is.md

@@ -38,6 +38,7 @@
 | **ClickPipes**                 | ClickPipes is ClickHouse's managed ingestion pipeline that allows you to seamlessly connect your external data sources like databases, APIs, and streaming services into ClickHouse Cloud, eliminating the need for managing pipelines, custom jobs, or ETL processes. It supports workloads of all sizes. | ❌               | ✅                 |
 | **Pre-built integrations**     | ClickHouse provides pre-built integrations that connect ClickHouse to popular tools and services such as data lakes, SQL and language clients, visualization libraries, and more.                                                                                                                          | ❌               | ✅                 |
 | **SQL console**                | The SQL console offers a fast, intuitive way to connect, explore, and query ClickHouse databases, featuring a slick caption, query interface, data import tools, visualizations, collaboration features, and GenAI-powered SQL assistance.                                                                 | ❌               | ✅                 |
+| **ClickHouse CLI**             | The ClickHouse CLI (`clickhousectl`) lets you install and manage local ClickHouse versions, launch servers, run queries, and manage ClickHouse Cloud services and resources.                                                                                                             | ✅               | ✅                 |
 | **Compliance**                 | ClickHouse Cloud compliance includes CCPA, EU-US DPF, GDPR, HIPAA, ISO 27001, ISO 27001 SoA, PCI DSS, SOC2. ClickHouse Cloud's security, availability, processing integrity, and confidentiality processes are all independently audited. Details: trust.clickhouse.com.                                   | ❌               | ✅                 |
 | **Enterprise-grade security**  | Support for advanced security features such as SSO, multi-factor authentication, role-based access control (RBAC), private and secure connections with support for Private Link and Private Service Connect, IP filtering, customer-managed encryption keys (CMEK), and more.                              | ❌               | ✅                 |
 | **Scaling and optimization**   | Seamlessly scales up or down based on workload, supporting both horizontal and vertical scaling. With automated backups, replication, and high availability, ClickHouse, it provides users with optimal resource allocation.                                                                               | ❌               | ✅                 |

docs/deployment-modes.md

@@ -1,7 +1,7 @@
 ---
 slug: /deployment-modes
 sidebar_label: 'Deployment modes'
-description: 'ClickHouse offers four deployment options that all use the same powerful database engine, just packaged differently to suit your specific needs.'
+description: 'ClickHouse offers five deployment options that all use the same powerful database engine, just packaged differently to suit your specific needs.'
 title: 'Deployment modes'
 keywords: ['Deployment Modes', 'chDB']
 show_related_blogs: true
@@ -17,10 +17,11 @@ import Image from '@theme/IdealImage';
 ClickHouse is a versatile database system that can be deployed in several different ways depending on your needs. At its core, all deployment options **use the same powerful ClickHouse database engine** – what differs is how you interact with it and where it runs.
 
 Whether you're running large-scale analytics in production, doing local data analysis, or building applications, there's a deployment option designed for your use case. The consistency of the underlying engine means you get the same high performance and SQL compatibility across all deployment modes.
-This guide explores the four main ways to deploy and use ClickHouse:
+This guide explores the five main ways to deploy and use ClickHouse:
 
 * ClickHouse Server for traditional client/server deployments
 * ClickHouse Cloud for fully managed database operations
+* ClickHouse CLI for local development and cloud management
 * clickhouse-local for command-line data processing
 * chDB for embedding ClickHouse directly in applications
 
@@ -54,6 +55,24 @@ For monitoring and optimization, ClickHouse Cloud includes built-in charts and [
 
 The managed nature of the service means you don't need to worry about updates, backups, scaling, or security patches – these are all handled automatically. This makes it an ideal choice for organizations that want to focus on their data and applications rather than database administration.
 
+## ClickHouse CLI {#clickhouse-cli}
+
+The ClickHouse CLI (`clickhousectl`) is a command-line tool for local ClickHouse development and ClickHouse Cloud management. It simplifies the workflow of installing ClickHouse versions, launching and managing local server instances, and running queries.
+
+For local development, `clickhousectl` helps to install ClickHouse versions and run servers. You can install any ClickHouse version, spin up named servers, and connect via the built-in client. Each server gets its own data directory, so you can run multiple isolated environments side by side.
+
+`clickhousectl` also provides full management of ClickHouse Cloud resources, including creating and scaling services, managing API keys, and administering organizations, making it a unified tool for both local and cloud workflows.
+
+```bash
+# Install the CLI
+curl https://clickhouse.com/cli | sh
+
+# Install and start ClickHouse locally
+clickhousectl local install stable
+clickhousectl local server start
+clickhousectl local client
+```
+
 ## clickhouse-local {#clickhouse-local}
 
 [clickhouse-local](/operations/utilities/clickhouse-local) is a powerful command-line tool that provides the complete functionality of ClickHouse in a standalone executable. It's essentially the same database as ClickHouse Server, but packaged in a way that lets you harness all of ClickHouse's capabilities directly from the command line without running a server instance.

docs/getting-started/install/_snippets/_cli_install.md

@@ -0,0 +1,66 @@
+# Install ClickHouse using the ClickHouse CLI
+
+The ClickHouse CLI (`clickhousectl`) helps you install and manage local ClickHouse
+versions, launch servers, and run queries.
+
+<VerticalStepper>
+
+## Install the ClickHouse CLI {#install-the-cli}
+
+```bash
+curl https://clickhouse.com/cli | sh
+```
+
+A `chctl` alias is also created automatically for convenience.
+
+## Install ClickHouse {#cli-install-clickhouse}
+
+Install the latest stable version of ClickHouse:
+
+```bash
+clickhousectl local install stable
+```
+
+You can also install a specific version:
+
+```bash
+clickhousectl local install lts             # Latest LTS release
+clickhousectl local install 25.6            # Latest 25.6.x.x
+clickhousectl local install 25.6.1.1        # Exact version
+```
+
+## Start clickhouse-server {#cli-start-clickhouse-server}
+
+```bash
+clickhousectl local server start
+```
+
+The server runs in the background. To verify it's running:
+
+```bash
+clickhousectl local server list
+```
+
+## Start clickhouse-client {#cli-start-clickhouse-client}
+
+```bash
+clickhousectl local client
+```
+
+You will see something like this:
+
+```response
+ClickHouse client version 24.5.1.117 (official build).
+Connecting to localhost:9000 as user default.
+Connected to ClickHouse server version 24.5.1.
+
+local-host :)
+```
+
+You're now ready to start sending SQL commands to ClickHouse!
+
+:::tip
+The [Quick Start](/get-started/quick-start) walks you through the steps for creating tables and inserting data.
+:::
+
+</VerticalStepper>

docs/getting-started/install/_snippets/_quick_install.md

@@ -1,8 +1,6 @@
 # Install ClickHouse via script using curl
 
-If you don't need to install ClickHouse for production, the quickest way to get 
-set up is to run an install script using curl. The script will determine a suitable
-binary for your OS.
+If you don't need to install ClickHouse for production, you can run an install script using curl. The script will determine a suitable binary for your OS.
 
 <VerticalStepper>
 

docs/getting-started/install/install.mdx

@@ -8,6 +8,7 @@ doc_type: 'guide'
 ---
 
 import InstallSelector from '@site/src/components/Install/Install'
+import CLIInstall from './_snippets/_cli_install.md'
 import Windows from './_snippets/_windows_install.md'
 import TarProd from './_snippets/_linux_tar_install.md'
 import QuickInstall from './_snippets/_quick_install.md'
@@ -40,6 +41,7 @@ Alternatively, select a platform, distribution and install method below to view
 instructions for Opensource ClickHouse:
 
 <InstallSelector
+    cli={<CLIInstall/>}
     windows={<Windows/>}
     quickinstall={<QuickInstall/>}
     debian_prod={<DebianProd/>}

docs/getting-started/install/quick-install.md

@@ -0,0 +1,84 @@
+---
+description: 'Quickly install ClickHouse using the CLI or curl'
+keywords: ['ClickHouse', 'install', 'quick', 'curl', 'clickhousectl', 'CLI']
+sidebar_label: 'Quick install'
+slug: /install/quick-install
+title: 'Quick install'
+hide_title: true
+doc_type: 'guide'
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import QuickInstall from './_snippets/_quick_install.md'
+
+# Quick install
+
+If you don't need to install ClickHouse for production, the quickest way to get
+set up is using the ClickHouse CLI or running an install script using curl.
+
+<Tabs>
+  <TabItem value="cli" label="ClickHouse CLI" default>
+
+The ClickHouse CLI (`clickhousectl`) helps you install and manage local ClickHouse
+versions, launch servers, and run queries.
+
+<VerticalStepper>
+
+## Install the ClickHouse CLI {#install-the-cli}
+
+```bash
+curl https://clickhouse.com/cli | sh
+```
+
+A `chctl` alias is also created automatically for convenience.
+
+## Install ClickHouse {#install-clickhouse}
+
+```bash
+clickhousectl local install stable
+```
+
+## Start clickhouse-server {#start-clickhouse-server}
+
+```bash
+clickhousectl local server start
+```
+
+The server runs in the background. To verify it's running:
+
+```bash
+clickhousectl local server list
+```
+
+## Start clickhouse-client {#start-clickhouse-client}
+
+```bash
+clickhousectl local client
+```
+
+You will see something like this:
+
+```response
+ClickHouse client version 24.5.1.117 (official build).
+Connecting to localhost:9000 as user default.
+Connected to ClickHouse server version 24.5.1.
+
+local-host :)
+```
+
+You're now ready to start sending SQL commands to ClickHouse!
+
+:::tip
+The [Quick Start](/get-started/quick-start) walks you through the steps for creating tables and inserting data.
+:::
+
+</VerticalStepper>
+
+  </TabItem>
+  <TabItem value="curl" label="Curl script">
+
+<QuickInstall/>
+
+  </TabItem>
+</Tabs>