From 24588014993a164078f0d69120af4aaed1df7066 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 4 Jun 2026 17:02:43 +0000 Subject: [PATCH] docs: port restore curl quick install and clickhousectl page from upstream PR #6343 --- core/get-started/navigation.json | 2 ++ core/get-started/setup/install.mdx | 5 ++++- .../setup/self-managed/clickhousectl.mdx | 18 ++++++++++++++++++ .../setup/self-managed/install-curl.mdx | 13 +++++++++++++ products/cloud/features/cli.mdx | 2 +- snippets/_quick_install.mdx | 12 +++++++++++- 6 files changed, 49 insertions(+), 3 deletions(-) create mode 100644 core/get-started/setup/self-managed/clickhousectl.mdx create mode 100644 core/get-started/setup/self-managed/install-curl.mdx diff --git a/core/get-started/navigation.json b/core/get-started/navigation.json index 3bc1579f..376f6491 100644 --- a/core/get-started/navigation.json +++ b/core/get-started/navigation.json @@ -50,6 +50,8 @@ "root": "core/get-started/setup/self-managed/overview", "pages": [ "core/get-started/setup/self-managed/quick-install", + "core/get-started/setup/self-managed/install-curl", + "core/get-started/setup/self-managed/clickhousectl", "core/get-started/setup/self-managed/debian-ubuntu", "core/get-started/setup/self-managed/redhat", "core/get-started/setup/self-managed/other-linux", diff --git a/core/get-started/setup/install.mdx b/core/get-started/setup/install.mdx index 06e24ca3..08841bc7 100644 --- a/core/get-started/setup/install.mdx +++ b/core/get-started/setup/install.mdx @@ -27,9 +27,12 @@ required. Spin up a managed ClickHouse service in minutes — no infrastructure to operate. - + One-line install script for trying ClickHouse locally on Linux or macOS. + + Install and manage local ClickHouse versions using the ClickHouse CLI. + Install via `apt-get` from the official ClickHouse repository. diff --git a/core/get-started/setup/self-managed/clickhousectl.mdx b/core/get-started/setup/self-managed/clickhousectl.mdx new file mode 100644 index 00000000..0e004d6c --- /dev/null +++ b/core/get-started/setup/self-managed/clickhousectl.mdx @@ -0,0 +1,18 @@ +--- +description: 'Install and manage local ClickHouse versions using clickhousectl, the ClickHouse CLI' +keywords: ['ClickHouse', 'install', 'clickhousectl', 'CLI'] +sidebarTitle: 'clickhousectl (CLI)' +slug: /install/clickhousectl +title: 'Install with the ClickHouse CLI' +hide_title: true +doc_type: 'guide' +--- + +import CLIInstall from '/snippets/_cli_install.mdx' + + +**Windows users**: ClickHouse runs natively on Linux and macOS. On Windows, run these steps inside +the [Windows Subsystem for Linux (WSL)](https://learn.microsoft.com/en-us/windows/wsl/about). + + + diff --git a/core/get-started/setup/self-managed/install-curl.mdx b/core/get-started/setup/self-managed/install-curl.mdx new file mode 100644 index 00000000..27489b6d --- /dev/null +++ b/core/get-started/setup/self-managed/install-curl.mdx @@ -0,0 +1,13 @@ +--- +description: 'Quickly install ClickHouse using a curl install script' +keywords: ['ClickHouse', 'install', 'quick', 'curl'] +sidebarTitle: 'Quick install' +slug: /install/quick-install +title: 'Quick install' +hide_title: true +doc_type: 'guide' +--- + +import QuickInstall from '/snippets/_quick_install.mdx' + + diff --git a/products/cloud/features/cli.mdx b/products/cloud/features/cli.mdx index 88c788af..84a6384c 100644 --- a/products/cloud/features/cli.mdx +++ b/products/cloud/features/cli.mdx @@ -135,7 +135,7 @@ clickhousectl cloud --json service list ## Local development {#local-development} -The CLI also manages local ClickHouse installations and servers. See the [quick install](/core/get-started/setup/self-managed/quick-install) page for getting started with local development. +The CLI also manages local ClickHouse installations and servers. See the [clickhousectl (CLI)](/install/clickhousectl) page for getting started with local development. ## Requirements {#requirements} diff --git a/snippets/_quick_install.mdx b/snippets/_quick_install.mdx index 7b52e6a3..e4723c0b 100644 --- a/snippets/_quick_install.mdx +++ b/snippets/_quick_install.mdx @@ -6,12 +6,22 @@ If you don't need to install ClickHouse for production, you can run an install s ## Install ClickHouse using curl {#install-clickhouse-using-curl} -Run the following comand to download a single binary for your operating system. +Run the following command to download a single binary for your operating system. ```bash curl https://clickhouse.com/ | sh ``` +On Linux and macOS, this also installs [`clickhousectl`](https://github.com/ClickHouse/clickhousectl) +(with a `chctl` symlink) so you can manage local ClickHouse versions and servers. + +To install just the `clickhouse` binary without `clickhousectl`, set +`CLICKHOUSE_ONLY=1`: + +```bash +curl https://clickhouse.com/ | CLICKHOUSE_ONLY=1 sh +``` + For Mac users: If you're getting errors that the developer of the binary can't be verified, please see [here](/resources/support-center/knowledge-base/troubleshooting/fix-developer-verification-error-in-macos).