From 10dbb682f484c0ca39ae8dffeacefe7fb6dd6957 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 4 Jun 2026 08:49:32 +0000 Subject: [PATCH] docs: port clickhousectl local use + Install IA restructure (clickhouse-docs#6334) --- core/get-started/about/deployment-modes.mdx | 4 +- core/get-started/navigation.json | 28 ++++++++----- core/get-started/setup/install.mdx | 39 ++++++++++++------- .../setup/self-managed/advanced.mdx | 4 +- .../setup/self-managed/overview.mdx | 33 +++++++++------- .../setup/self-managed/quick-install.mdx | 33 ++++++++++++++-- snippets/_cli_install.mdx | 24 +++++++++--- 7 files changed, 114 insertions(+), 51 deletions(-) diff --git a/core/get-started/about/deployment-modes.mdx b/core/get-started/about/deployment-modes.mdx index e723500a..f4e28d30 100644 --- a/core/get-started/about/deployment-modes.mdx +++ b/core/get-started/about/deployment-modes.mdx @@ -65,8 +65,8 @@ For local development, `clickhousectl` helps to install ClickHouse versions and # Install the CLI curl https://clickhouse.com/cli | sh -# Install and start ClickHouse locally -clickhousectl local install stable +# Install the latest stable ClickHouse, set it as your default, and symlink the clickhouse binary onto your PATH +clickhousectl local use stable clickhousectl local server start clickhousectl local client ``` diff --git a/core/get-started/navigation.json b/core/get-started/navigation.json index 3bc1579f..f736f045 100644 --- a/core/get-started/navigation.json +++ b/core/get-started/navigation.json @@ -49,15 +49,25 @@ "expanded": true, "root": "core/get-started/setup/self-managed/overview", "pages": [ - "core/get-started/setup/self-managed/quick-install", - "core/get-started/setup/self-managed/debian-ubuntu", - "core/get-started/setup/self-managed/redhat", - "core/get-started/setup/self-managed/other-linux", - "core/get-started/setup/self-managed/macos", - "core/get-started/setup/self-managed/windows", - "core/get-started/setup/self-managed/docker", - "core/get-started/setup/self-managed/nixos", - "core/get-started/setup/self-managed/advanced" + { + "group": "Local development", + "expanded": true, + "pages": [ + "core/get-started/setup/self-managed/quick-install", + "core/get-started/setup/self-managed/docker", + "core/get-started/setup/self-managed/advanced" + ] + }, + { + "group": "Production server", + "expanded": true, + "pages": [ + "core/get-started/setup/self-managed/debian-ubuntu", + "core/get-started/setup/self-managed/redhat", + "core/get-started/setup/self-managed/other-linux", + "core/get-started/setup/self-managed/nixos" + ] + } ] }, { diff --git a/core/get-started/setup/install.mdx b/core/get-started/setup/install.mdx index 06e24ca3..18a933af 100644 --- a/core/get-started/setup/install.mdx +++ b/core/get-started/setup/install.mdx @@ -27,9 +27,32 @@ required. Spin up a managed ClickHouse service in minutes — no infrastructure to operate. + + Move data from PostgreSQL, BigQuery, Snowflake, Redshift, Elasticsearch, and more. + + + +## Local development + +For trying ClickHouse locally on your laptop. + + - One-line install script for trying ClickHouse locally on Linux or macOS. + One-line install via the ClickHouse CLI (`clickhousectl`) on Linux or macOS. + + + Run ClickHouse in a Docker container. + + + Compile from source or use a CI-generated binary. + + +## Production server + +For running ClickHouse Server on production hardware. + + Install via `apt-get` from the official ClickHouse repository. @@ -39,19 +62,7 @@ required. Install on other Linux distributions via the prebuilt tarball. - - Install on macOS via the prebuilt binary or Homebrew. - - - Install on Windows via WSL. - - - Run ClickHouse in a Docker container. - Install on NixOS via the Nix package manager. - - Move data from PostgreSQL, BigQuery, Snowflake, Redshift, Elasticsearch, and more. - - \ No newline at end of file + diff --git a/core/get-started/setup/self-managed/advanced.mdx b/core/get-started/setup/self-managed/advanced.mdx index aeed2556..a58d065a 100644 --- a/core/get-started/setup/self-managed/advanced.mdx +++ b/core/get-started/setup/self-managed/advanced.mdx @@ -1,9 +1,9 @@ --- description: 'Instructions for compiling ClickHouse from source or installing a CI-generated binary' keywords: ['ClickHouse', 'install', 'advanced', 'compile from source', 'CI generated binary'] -sidebarTitle: 'Advanced install' +sidebarTitle: 'Source & CI builds' slug: /install/advanced -title: 'Advanced installation methods' +title: 'Source & CI builds' hide_title: false doc_type: 'guide' --- diff --git a/core/get-started/setup/self-managed/overview.mdx b/core/get-started/setup/self-managed/overview.mdx index 71695c6f..19c693d6 100644 --- a/core/get-started/setup/self-managed/overview.mdx +++ b/core/get-started/setup/self-managed/overview.mdx @@ -3,15 +3,32 @@ title: 'Self-managed install' sidebarTitle: 'Overview' description: 'Install ClickHouse on your own infrastructure.' doc_type: 'landing-page' -keywords: ['install', 'self-managed', 'linux', 'macos', 'windows', 'docker'] +keywords: ['install', 'self-managed', 'linux', 'docker'] --- Install ClickHouse on the platform you operate. +## Local development + +For trying ClickHouse locally on your laptop. + - Fastest path: download the universal binary and run. + One-line install via the ClickHouse CLI (`clickhousectl`) on Linux or macOS. + + + Pull the official Docker image and run a container. + + Compile from source or use a CI-generated binary. + + + +## Production server + +For running ClickHouse Server on production hardware. + + Install via the official APT repository. @@ -21,19 +38,7 @@ Install ClickHouse on the platform you operate. Generic Linux distribution install via tarball. - - Install on macOS with Homebrew or the universal binary. - - - Run ClickHouse on Windows via WSL. - - - Pull the official Docker image and run a container. - Install on NixOS via the package manager. - - Build from source and other advanced installation paths. - diff --git a/core/get-started/setup/self-managed/quick-install.mdx b/core/get-started/setup/self-managed/quick-install.mdx index 6d79864d..21cd633a 100644 --- a/core/get-started/setup/self-managed/quick-install.mdx +++ b/core/get-started/setup/self-managed/quick-install.mdx @@ -16,14 +16,33 @@ insert data into it, and run a SELECT query. ## Install the ClickHouse CLI {#install-the-cli} -The ClickHouse CLI (`clickhousectl`) helps you install and manage local ClickHouse -versions, launch servers, and run queries. Install it with: + +The ClickHouse CLI (`clickhousectl`) helps you install local ClickHouse +versions, launch servers, run queries and manage ClickHouse Cloud. + +Install it with: ```bash curl https://clickhouse.com/cli | sh ``` A `chctl` alias is also created automatically for convenience. + + + +If you only need the `clickhouse` binary and don't want `clickhousectl`, use the +universal installer with `CLICKHOUSE_ONLY=1`: + +```bash +curl https://clickhouse.com/ | CLICKHOUSE_ONLY=1 sh +``` + +This downloads a single `clickhouse` binary into the current directory. You can +then run `clickhouse-server`, `clickhouse-client`, and `clickhouse-local` +directly from that binary, and the rest of this guide's `clickhousectl`-based +steps won't apply. + + ## Install ClickHouse {#install-clickhouse} @@ -31,12 +50,18 @@ A `chctl` alias is also created automatically for convenience. ClickHouse runs natively on Linux and macOS, and runs on Windows via the [WSL](https://learn.microsoft.com/en-us/windows/wsl/about). -Use the CLI to install the latest stable version of ClickHouse: +Use the CLI to install the latest stable version of ClickHouse and make it your default: ```bash -clickhousectl local install stable +clickhousectl local use stable ``` +`local use` installs the version if it isn't already present, sets it as your +default, and creates a `clickhouse` symlink in `~/.local/bin` (on your `PATH`) +so you can invoke the `clickhouse` binary directly. The later steps in this +guide rely on that symlink. To download a version without changing your default +or updating the symlink, use `clickhousectl local install ` instead. + This isn't the recommended way to install ClickHouse for production. If you're looking to install a production instance of ClickHouse, please see the [install page](/core/get-started/setup/install). diff --git a/snippets/_cli_install.mdx b/snippets/_cli_install.mdx index 38f5f6c6..80a297ef 100644 --- a/snippets/_cli_install.mdx +++ b/snippets/_cli_install.mdx @@ -16,19 +16,31 @@ A `chctl` alias is also created automatically for convenience. ## Install ClickHouse {#cli-install-clickhouse} -Install the latest stable version of ClickHouse: +Install the latest stable version of ClickHouse and make it your default: ```bash -clickhousectl local install stable +clickhousectl local use stable ``` -You can also install a specific version: +`local use` installs the version if it isn't already present, sets it as your +default, and creates a `clickhouse` symlink in `~/.local/bin` (on your `PATH`) +so you can invoke the `clickhouse` binary directly. Any later step in these docs +that runs a `clickhouse` command then works as-is. + +You can also select 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 +clickhousectl local use lts # Latest LTS release +clickhousectl local use 25.6 # Latest 25.6.x.x +clickhousectl local use 25.6.1.1 # Exact version ``` + + +**Use vs install** — `clickhousectl local use ` installs a version *and* makes it your +default, updating the `clickhouse` symlink on your `PATH`. To download a version +without changing your default or updating the symlink, use +`clickhousectl local install ` instead. + ## Start clickhouse-server {#cli-start-clickhouse-server}