> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-fix-nav-issues.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# ClickHouse CLI

> ClickHouse CLI를 사용하여 ClickHouse Cloud 서비스와 로컬 ClickHouse 인스턴스를 관리합니다

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

<div id="installation">
  ## 설치
</div>

```bash theme={null}
curl https://clickhouse.com/cli | sh
```

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

<div id="cloud-management">
  ## Cloud 관리
</div>

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

<div id="authentication">
  ### 인증
</div>

```bash theme={null}
clickhousectl cloud auth
```

API Key와 시크릿 입력 메시지가 표시되며, 입력한 값은 `.clickhouse/credentials.json`에 저장됩니다(현재 프로젝트에만 적용되며, git에서는 무시됩니다).

환경 변수도 사용할 수 있습니다:

```bash theme={null}
export CLICKHOUSE_CLOUD_API_KEY=your-key
export CLICKHOUSE_CLOUD_API_SECRET=your-secret
```

<div id="services">
  ### 서비스
</div>

```bash theme={null}
# 서비스 목록 조회
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>
```

<div id="postgres-services">
  ### Postgres 서비스(베타)
</div>

[ClickHouse Cloud Postgres](/ko/products/managed-postgres/overview) 서비스를 생성하고 관리합니다.

```bash theme={null}
# Postgres 서비스 목록 조회
clickhousectl cloud postgres list

# Postgres 서비스 생성
clickhousectl cloud postgres create \
  --name my-pg \
  --region us-east-1 \
  --size c6gd.xlarge \
  --pg-version 18

# 서비스 상세 정보 조회
clickhousectl cloud postgres get <pg-id>

# 서비스 업데이트
clickhousectl cloud postgres update <pg-id> --size c6gd.2xlarge --add-tag env=prod

# 비밀번호 재설정
clickhousectl cloud postgres reset-password <pg-id> --generate

# 읽기 레플리카 및 특정 시점 복원
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

# 서비스 삭제
clickhousectl cloud postgres delete <pg-id>
```

<div id="organizations">
  ### 조직
</div>

```bash theme={null}
clickhousectl cloud org list
clickhousectl cloud org get <org-id>
```

<div id="api-keys">
  ### API Keys
</div>

```bash theme={null}
clickhousectl cloud key list
clickhousectl cloud key create --name ci-key --role-id <role-id>
clickhousectl cloud key delete <key-id>
```

<div id="members-and-invitations">
  ### 구성원 및 초대
</div>

```bash theme={null}
clickhousectl cloud member list
clickhousectl cloud invitation create --email dev@example.com --role-id <role-id>
```

<div id="backups">
  ### 백업
</div>

```bash theme={null}
clickhousectl cloud backup list <service-id>
clickhousectl cloud backup get <service-id> <backup-id>
```

<div id="json-output">
  ### JSON 출력
</div>

`--json` 플래그를 사용하면 모든 cloud 명령의 응답을 JSON 포맷으로 받을 수 있습니다:

```bash theme={null}
clickhousectl cloud --json service list
```

<div id="local-development">
  ## 로컬 개발
</div>

CLI는 로컬 ClickHouse 설치와 서버도 관리합니다. 로컬 개발을 시작하려면 [빠른 설치](/ko/get-started/setup/self-managed/quick-install) 페이지를 확인하십시오.

<div id="requirements">
  ## 요구 사항
</div>

* macOS (aarch64, x86\_64) 또는 Linux (aarch64, x86\_64)
* Cloud 명령을 실행하려면 [ClickHouse Cloud API Key](/ko/products/cloud/features/admin-features/api/openapi)가 필요합니다