Skip to content

Commit c7fc0c9

Browse files
sdairsclaude
sdairs
and
claude
committed
Restore curl Quick install; move clickhousectl to its own page
Yesterday's "Make clickhousectl the recommended local install method" change replaced the curl-based Quick install flow with clickhousectl. This restores curl as the Quick install page and gives clickhousectl its own page, so both methods are documented side by side. - quick-install.md (/install/quick-install) now renders the curl flow via the _quick_install.md snippet. - New clickhousectl.md (/install/clickhousectl, label "clickhousectl (CLI)") renders the _cli_install.md snippet, sitting directly below Quick install in the Local development sidebar group. - install.mdx Local development cards: Quick install now shows the curl steps and a new "clickhousectl (CLI)" card (console icon) shows the clickhousectl steps. - Repoint the cloud CLI page's local-development link to /install/clickhousectl (it's specifically about the CLI managing local installs). - Docs home "Connect to ClickHouse": rename the button from "ClickHouse CLI" -> "ClickHouse Client" and point it at /interfaces/client instead of /interfaces/cli (which is clickhousectl). Updated i18n keys to match. - Drop the PATH note from the curl snippet. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent cbd69e3 commit c7fc0c9

13 files changed

Lines changed: 58 additions & 97 deletions

File tree

‎docs/cloud/features/02b_cli.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ clickhousectl cloud --json service list
136136

137137
## Local development {#local-development}
138138

139-
The CLI also manages local ClickHouse installations and servers. See the [quick install](/install/quick-install) page for getting started with local development.
139+
The CLI also manages local ClickHouse installations and servers. See the [clickhousectl (CLI)](/install/clickhousectl) page for getting started with local development.
140140

141141
## Requirements {#requirements}
142142

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,7 @@ curl https://clickhouse.com/ | sh
1414

1515
On Linux and macOS, this also installs [`clickhousectl`](https://github.com/ClickHouse/clickhousectl)
1616
into `~/.local/bin` (with a `chctl` symlink) so you can manage local ClickHouse
17-
versions and servers. If `~/.local/bin` isn't already on your `PATH`, the
18-
installer prints the line to add to your shell profile.
17+
versions and servers.
1918

2019
To install just the `clickhouse` binary without `clickhousectl`, set
2120
`CLICKHOUSE_ONLY=1`:

‎docs/getting-started/install/clickhousectl.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
description: 'Install and manage local ClickHouse versions using clickhousectl, the ClickHouse CLI'
3+
keywords: ['ClickHouse', 'install', 'clickhousectl', 'CLI']
4+
sidebar_label: 'clickhousectl (CLI)'
5+
slug: /install/clickhousectl
6+
title: 'Install with the ClickHouse CLI'
7+
hide_title: true
8+
doc_type: 'guide'
9+
---
10+
11+
import CLIInstall from './_snippets/_cli_install.md'
12+
13+
:::note Windows users
14+
ClickHouse runs natively on Linux and macOS. On Windows, run these steps inside
15+
the [Windows Subsystem for Linux (WSL)](https://learn.microsoft.com/en-us/windows/wsl/about).
16+
:::
17+
18+
<CLIInstall/>

‎docs/getting-started/install/install.mdx‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ doc_type: 'guide'
88
---
99

1010
import InstallSelector from '@site/src/components/Install/Install'
11+
import QuickInstall from './_snippets/_quick_install.md'
1112
import CLIInstall from './_snippets/_cli_install.md'
1213
import TarProd from './_snippets/_linux_tar_install.md'
1314
import DebianProd from './_snippets/_deb_install.md'
@@ -34,10 +35,11 @@ import {galaxyOnClick} from '@site/src/lib/galaxy/galaxy'
3435
<br/>
3536

3637
If you prefer to self-manage, select one of the open-source ClickHouse options below.
37-
Use the ClickHouse CLI for a quick local setup, or install ClickHouse Server
38-
from packages or binaries for a production deployment.
38+
Use the quick install script or the `clickhousectl` CLI for a local setup, or install
39+
ClickHouse Server from packages or binaries for a production deployment.
3940

4041
<InstallSelector
42+
quick_install={<QuickInstall/>}
4143
cli={<CLIInstall/>}
4244
debian_prod={<DebianProd/>}
4345
rpm_prod={<RPMProd/>}

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

Lines changed: 4 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -1,85 +1,13 @@
11
---
2-
description: 'Quickly install ClickHouse using the ClickHouse CLI'
3-
keywords: ['ClickHouse', 'install', 'quick', 'clickhousectl', 'CLI']
2+
description: 'Quickly install ClickHouse using a curl install script'
3+
keywords: ['ClickHouse', 'install', 'quick', 'curl']
44
sidebar_label: 'Quick install'
55
slug: /install/quick-install
66
title: 'Quick install'
77
hide_title: true
88
doc_type: 'guide'
99
---
1010

11-
If you don't need to install ClickHouse for production, the quickest way to get
12-
set up is using the ClickHouse CLI (`clickhousectl`), which helps you install
13-
local ClickHouse versions, launch servers, run queries and manage ClickHouse
14-
Cloud.
11+
import QuickInstall from './_snippets/_quick_install.md'
1512

16-
:::note Windows users
17-
ClickHouse runs natively on Linux and macOS. On Windows, run these steps inside
18-
the [Windows Subsystem for Linux (WSL)](https://learn.microsoft.com/en-us/windows/wsl/about).
19-
:::
20-
21-
<VerticalStepper>
22-
23-
## Install the ClickHouse CLI {#install-the-cli}
24-
25-
```bash
26-
curl https://clickhouse.com/cli | sh
27-
```
28-
29-
A `chctl` alias is also created automatically for convenience.
30-
31-
## Install ClickHouse {#install-clickhouse}
32-
33-
Install the latest stable version of ClickHouse and make it your default:
34-
35-
```bash
36-
clickhousectl local use stable
37-
```
38-
39-
`local use` installs the version if it isn't already present, sets it as your
40-
default, and creates a `clickhouse` symlink in `~/.local/bin` (on your `PATH`)
41-
so you can invoke the `clickhouse` binary directly. Any later step in these docs
42-
that runs a `clickhouse` command then works as-is.
43-
44-
:::note[Use vs install]
45-
`clickhousectl local use <version>` installs a version *and* makes it your
46-
default, updating the `clickhouse` symlink on your `PATH`. To download a version
47-
without changing your default or updating the symlink, use
48-
`clickhousectl local install <version>` instead.
49-
:::
50-
51-
## Start clickhouse-server {#start-clickhouse-server}
52-
53-
```bash
54-
clickhousectl local server start
55-
```
56-
57-
The server runs in the background. To verify it's running:
58-
59-
```bash
60-
clickhousectl local server list
61-
```
62-
63-
## Start clickhouse-client {#start-clickhouse-client}
64-
65-
```bash
66-
clickhousectl local client
67-
```
68-
69-
You will see something like this:
70-
71-
```response
72-
ClickHouse client version 24.5.1.117 (official build).
73-
Connecting to localhost:9000 as user default.
74-
Connected to ClickHouse server version 24.5.1.
75-
76-
local-host :)
77-
```
78-
79-
You're now ready to start sending SQL commands to ClickHouse!
80-
81-
:::tip
82-
The [Quick Start](/get-started/quick-start) walks you through the steps for creating tables and inserting data.
83-
:::
84-
85-
</VerticalStepper>
13+
<QuickInstall/>

‎i18n/en/code.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1686,8 +1686,8 @@
16861686
"homepage.connect.viewAll": {
16871687
"message": "View All Clients and Drivers"
16881688
},
1689-
"homepage.connect.clickhouseCli": {
1690-
"message": "ClickHouse CLI"
1689+
"homepage.connect.clickhouseClient": {
1690+
"message": "ClickHouse Client"
16911691
},
16921692
"homepage.connect.cloudSqlConsole": {
16931693
"message": "Cloud SQL Console"

‎i18n/jp/code.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
"This documentation is translated with the help of AI": {
99
"message": "このドキュメントは AI を活用して翻訳されています。"
1010
},
11-
"homepage.connect.clickhouseCli": {
12-
"message": "ClickHouse CLI"
11+
"homepage.connect.clickhouseClient": {
12+
"message": "ClickHouse Client"
1313
},
1414
"homepage.connect.cloudSqlConsole": {
1515
"message": "Cloud SQL コンソール"

‎i18n/ko/code.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
"This documentation is translated with the help of AI": {
99
"message": "이 문서는 AI의 도움을 받아 번역되었습니다."
1010
},
11-
"homepage.connect.clickhouseCli": {
12-
"message": "ClickHouse CLI"
11+
"homepage.connect.clickhouseClient": {
12+
"message": "ClickHouse Client"
1313
},
1414
"homepage.connect.cloudSqlConsole": {
1515
"message": "Cloud SQL 콘솔"

‎i18n/ru/code.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
"This documentation is translated with the help of AI": {
99
"message": "Этот документ переведён с помощью ИИ."
1010
},
11-
"homepage.connect.clickhouseCli": {
12-
"message": "ClickHouse CLI"
11+
"homepage.connect.clickhouseClient": {
12+
"message": "ClickHouse Client"
1313
},
1414
"homepage.connect.cloudSqlConsole": {
1515
"message": "SQL-консоль Cloud"

‎i18n/zh/code.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
"This documentation is translated with the help of AI": {
99
"message": "本页内容由 AI 翻译生成。"
1010
},
11-
"homepage.connect.clickhouseCli": {
12-
"message": "ClickHouse 命令行工具"
11+
"homepage.connect.clickhouseClient": {
12+
"message": "ClickHouse 客户端"
1313
},
1414
"homepage.connect.cloudSqlConsole": {
1515
"message": "Cloud SQL 控制台"

0 commit comments

Comments
 (0)