Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs
49.6kGet Started

ClickHouse CLI

View as MarkdownEdit this pageReport an issueSet up docs MCP

ClickHouse 命令行客户端 (clickhousectl) 是一款统一的命令行工具，用于管理 ClickHouse Cloud 资源，并支持基于 ClickHouse 的本地开发。它还可管理 ClickHouse Cloud Postgres 服务。

安装

curl https://clickhouse.com/cli | sh

为方便使用，系统还会自动创建一个 chctl 别名。

Cloud 管理

直接通过命令行在 ClickHouse Cloud 中完成身份验证并管理您的服务。

身份验证

clickhousectl cloud auth

系统会提示你输入 API 密钥 和 secret，并将它们保存到 .clickhouse/credentials.json (仅限当前项目，且已加入 git 忽略) 。

你也可以使用环境变量：

export CLICKHOUSE_CLOUD_API_KEY=your-key
export CLICKHOUSE_CLOUD_API_SECRET=your-secret

服务

# 列出服务
clickhousectl cloud service list

# 创建服务
clickhousectl cloud service create --name my-service \
  --provider aws \
  --region us-east-1

# 获取服务详情
clickhousectl cloud service get <service-id>

# 扩缩服务
clickhousectl cloud service scale <service-id> \
  --min-replica-memory-gb 24 \
  --max-replica-memory-gb 48 \
  --num-replicas 3

# 启动/停止服务
clickhousectl cloud service start <service-id>
clickhousectl cloud service stop <service-id>

# 删除服务
clickhousectl cloud service delete <service-id>

Postgres 服务 (Beta)

创建和管理 ClickHouse Cloud Postgres 服务。

# List Postgres services
clickhousectl cloud postgres list

# Create a Postgres service
clickhousectl cloud postgres create \
  --name my-pg \
  --region us-east-1 \
  --size m6gd.xlarge \
  --pg-version 18

# Get service details
clickhousectl cloud postgres get <pg-id>

# Update a service
clickhousectl cloud postgres update <pg-id> --size m6gd.2xlarge --add-tag env=prod

# Reset the password
clickhousectl cloud postgres reset-password <pg-id> --generate

# Read replicas and point-in-time restore
clickhousectl cloud postgres read-replica create <pg-id> --name replica-1
clickhousectl cloud postgres restore <pg-id> --name restored --restore-target 2026-04-16T12:00:00Z

# Delete a service
clickhousectl cloud postgres delete <pg-id>

组织

clickhousectl cloud org list
clickhousectl cloud org get <org-id>

API 密钥

clickhousectl cloud key list
clickhousectl cloud key create --name ci-key --role-id <role-id>
clickhousectl cloud key delete <key-id>

成员与邀请

clickhousectl cloud member list
clickhousectl cloud invitation create --email dev@example.com --role-id <role-id>

备份

clickhousectl cloud backup list <service-id>
clickhousectl cloud backup get <service-id> <backup-id>

JSON 输出

使用 --json 标志可让任何云端命令返回 JSON 格式的响应：

clickhousectl cloud --json service list

本地开发

命令行客户端 还可管理本地的 ClickHouse 安装和服务器。要开始进行本地开发，请参阅 clickhousectl (CLI) 页面。

要求

Navigation