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

# 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](/fr/products/managed-postgres/overview).

<div id="installation">
  ## Installation
</div>

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

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

<div id="cloud-management">
  ## Gestion de Cloud
</div>

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

<div id="authentication">
  ### Authentification
</div>

```bash theme={null}
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 :

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

<div id="services">
  ### Services
</div>

```bash theme={null}
# 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>
```

<div id="postgres-services">
  ### Services Postgres (bêta)
</div>

Créez et gérez les services [ClickHouse Cloud Postgres](/fr/products/managed-postgres/overview).

```bash theme={null}
# 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>
```

<div id="organizations">
  ### Organisations
</div>

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

<div id="api-keys">
  ### Clés API
</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">
  ### Membres et invitations
</div>

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

<div id="backups">
  ### Sauvegardes
</div>

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

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

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

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

<div id="local-development">
  ## Développement local
</div>

Le CLI gère également les installations et les serveurs ClickHouse en local. Consultez la page [clickhousectl (CLI)](/fr/get-started/setup/self-managed/clickhousectl) pour bien démarrer en développement local.

<div id="requirements">
  ## Prérequis
</div>

* MacOS (aarch64, x86\_64) ou Linux (aarch64, x86\_64)
* Les commandes Cloud nécessitent une [clé API ClickHouse Cloud](/fr/products/cloud/features/admin-features/api/openapi)