Skip to content

Document clickhousectl install in universal installer #6254

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Blargian wants to merge 1 commit into
base: main
Choose a base branch
from
+31 −1
Open

Document clickhousectl install in universal installer #6254

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion docs/getting-started/install/_snippets/_quick_install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,24 @@

## 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)
into `~/.local/bin` (with a `chctl` symlink) so you can manage local ClickHouse
versions and servers. If `~/.local/bin` isn't already on your `PATH`, the
installer prints the line to add to your shell profile.

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

```bash

Check notice on line 23 in docs/getting-started/install/_snippets/_quick_install.md

View workflow job for this annotation

GitHub Actions / vale

ClickHouse.CodeblockFences 

Suggestion: Instead of '```bash' for the code block, use yaml, ruby, plaintext, markdown, javascript, shell, go, python, dockerfile, or typescript.
curl https://clickhouse.com/ | CLICKHOUSE_ONLY=1 sh
```

:::note
For Mac users: If you're getting errors that the developer of the binary can't be verified, please see [here](/knowledgebase/fix-developer-verification-error-in-macos).
:::
Expand Down
18 changes: 18 additions & 0 deletions docs/getting-started/quick-start/oss.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,24 @@ curl https://clickhouse.com/cli | sh

A `chctl` alias is also created automatically for convenience.

<details>
<summary>Advanced: install ClickHouse without `clickhousectl`</summary>

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. See the [Quick install](/install/quick-install) page for the
plain-binary workflow.

</details>

## Install ClickHouse {#install-clickhouse}

ClickHouse runs natively on Linux and macOS, and runs on Windows via
Expand Down
Loading