Skip to content

docs: restore curl Quick install; add clickhousectl install page #125

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
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: restore curl Quick install; add clickhousectl install page #125

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
2 changes: 2 additions & 0 deletions core/get-started/navigation.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
5 changes: 4 additions & 1 deletion core/get-started/setup/install.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,12 @@ required.
<Card title="ClickHouse Cloud (Recommended)" icon="cloud" href="/core/get-started/setup/cloud">
Spin up a managed ClickHouse service in minutes — no infrastructure to operate.
</Card>
<Card title="Quick install" icon="bolt" href="/core/get-started/setup/self-managed/quick-install">
<Card title="Quick install" icon="bolt" href="/install/quick-install">
One-line install script for trying ClickHouse locally on Linux or macOS.
</Card>
<Card title="clickhousectl (CLI)" icon="terminal" href="/install/clickhousectl">
Install and manage local ClickHouse versions using the ClickHouse CLI.
</Card>
<Card title="Debian / Ubuntu" icon="ubuntu" href="/core/get-started/setup/self-managed/debian-ubuntu">
Install via `apt-get` from the official ClickHouse repository.
</Card>
Expand Down
18 changes: 18 additions & 0 deletions core/get-started/setup/self-managed/clickhousectl.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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'

<Note>
**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).
</Note>

<CLIInstall/>
13 changes: 13 additions & 0 deletions core/get-started/setup/self-managed/install-curl.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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'

<QuickInstall/>
2 changes: 1 addition & 1 deletion products/cloud/features/cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}

Expand Down
12 changes: 11 additions & 1 deletion snippets/_quick_install.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,22 @@ If you don't need to install ClickHouse for production, you can run an install s
<Step>
## 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
```

<Note>
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).
</Note>
Expand Down