Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs
49.6kGet Started

ClickHouse CLI

View as MarkdownEdit this pageReport an issueSet up docs MCP

ClickHouse CLI(clickhousectl)는 ClickHouse Cloud 리소스 관리와 로컬 환경에서의 ClickHouse 개발을 위한 통합 명령줄 도구입니다. 또한 ClickHouse Cloud Postgres 서비스 관리도 지원합니다.

설치

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

편의를 위해 chctl 별칭이 자동으로 함께 생성됩니다.

Cloud 관리

명령줄에서 직접 ClickHouse Cloud에 인증하고 서비스를 관리할 수 있습니다.

인증

clickhousectl cloud auth

API Key와 시크릿 입력 메시지가 표시되며, 입력한 값은 .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 서비스(베타)

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 Keys

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 플래그를 사용하면 모든 cloud 명령의 응답을 JSON 포맷으로 받을 수 있습니다:

clickhousectl cloud --json service list

로컬 개발

CLI는 로컬 ClickHouse 설치와 서버도 관리합니다. 로컬 개발을 시작하려면 clickhousectl (CLI) 페이지를 확인하십시오.

요구 사항

  • macOS (aarch64, x86_64) 또는 Linux (aarch64, x86_64)
  • Cloud 명령을 실행하려면 ClickHouse Cloud API Key가 필요합니다
Navigation