ClickHouse CLI

Utilisez ClickHouse CLI pour gérer les services ClickHouse Cloud et les instances ClickHouse locales

ClickHouse CLI (clickhousectl) est un outil de ligne de commande unifié permettant de gérer les ressources ClickHouse Cloud ainsi que le développement local avec ClickHouse. Il permet également de gérer les services ClickHouse Cloud Postgres.

​

Installation

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

Un alias chctl est également créé automatiquement pour plus de commodité.

​

Gestion de Cloud

Authentifiez-vous auprès de ClickHouse Cloud et gérez vos services directement depuis la ligne de commande.

​

Authentification

clickhousectl cloud auth

Cela vous demande votre clé API et votre secret, puis les enregistre dans .clickhouse/credentials.json (propre au projet, ignoré par Git).

Vous pouvez également utiliser des variables d’environnement :

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

​

Services

# List services
clickhousectl cloud service list

# Create a service
clickhousectl cloud service create --name my-service \
  --provider aws \
  --region us-east-1

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

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

# Start/stop a service
clickhousectl cloud service start <service-id>
clickhousectl cloud service stop <service-id>

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

​

Services Postgres (bêta)

Créez et gérez les services 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 c6gd.xlarge \
  --pg-version 18

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

# Update a service
clickhousectl cloud postgres update <pg-id> --size c6gd.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>

​

Organisations

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

​

Clés API

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

​

Membres et invitations

clickhousectl cloud member list
clickhousectl cloud invitation create --email [e-mail] --role-id <role-id>

​

Sauvegardes

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

​

Sortie JSON

Utilisez l’option --json pour obtenir des réponses au format JSON depuis n’importe quelle commande cloud :

clickhousectl cloud --json service list

​

Développement local

Le CLI gère également les installations et les serveurs ClickHouse en local. Consultez la page clickhousectl (CLI) pour bien démarrer en développement local.

​

Prérequis

• MacOS (aarch64, x86_64) ou Linux (aarch64, x86_64)
• Les commandes Cloud nécessitent une clé API ClickHouse Cloud