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) es una herramienta de línea de comandos unificada para gestionar recursos de ClickHouse Cloud y trabajar con ClickHouse en entornos de desarrollo local. También permite gestionar servicios de ClickHouse Cloud Postgres.

Instalación

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

También se crea automáticamente un alias para chctl por comodidad.

Administración de Cloud

Autentíquese con ClickHouse Cloud y administre sus servicios directamente desde la línea de comandos.

Autenticación

clickhousectl cloud auth

Esto te pide tu clave de API y tu secreto, y los guarda en .clickhouse/credentials.json (local del proyecto, ignorado por git).

También puedes usar variables de entorno:

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

Servicios

# Listar servicios
clickhousectl cloud service list

# Crear un servicio
clickhousectl cloud service create --name my-service \
  --provider aws \
  --region us-east-1

# Obtener detalles del servicio
clickhousectl cloud service get <service-id>

# Escalar un servicio
clickhousectl cloud service scale <service-id> \
  --min-replica-memory-gb 24 \
  --max-replica-memory-gb 48 \
  --num-replicas 3

# Iniciar/detener un servicio
clickhousectl cloud service start <service-id>
clickhousectl cloud service stop <service-id>

# Eliminar un servicio
clickhousectl cloud service delete <service-id>

Servicios de Postgres (beta)

Cree y administre los servicios de 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>

Organizaciones

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

Claves de la API

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

Miembros e invitaciones

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

Copias de seguridad

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

Salida JSON

Usa la opción --json para obtener respuestas en formato JSON de cualquier comando de la nube:

clickhousectl cloud --json service list

Desarrollo local

La CLI también gestiona instalaciones y servidores locales de ClickHouse. Consulta la página de clickhousectl (CLI) para empezar a trabajar con el desarrollo local.

Requisitos

Navigation