infra-clickhouse について
infra-clickhouseは、clickhousectlによるローカルのClickHouseとClickHouse Cloudの管理をエージェント向けに案内するスキルです。開発と本番の状況に応じて手順を振り分けます。
主な機能
- 01ローカルとクラウドの手順を区別
- 02該当するリファレンスへ誘導
- 03開発から本番への移行を案内
- 04CLIのインストール方法を説明
- 05JSON出力への対応を記載
活用シーン
- 01アプリ用のローカルClickHouseを用意
- 02ClickHouse Cloudサービスの作成や運用
- 03ローカル開発から本番へ移行
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ clickhouse/ agent-skills --skill infra-clickhouseインストール後、Claude Code で/infra-clickhouseを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
metadata.jsonREADME.mdref/cloud.mdlocal.md詳細
clickhousectl を使用した ClickHouse
clickhousectl は、次の 2 つの環境で ClickHouse を管理します。
- ローカル — 開発用に、ユーザーのマシンにインストールして実行する ClickHouse。
- クラウド — 本番環境向けのマネージド ClickHouse Cloud サービス。完全マネージド、自動スケーリング、バックアップ、アップグレードに対応します。
このファイルでは、適切なリファレンスへの案内を行います。手順ごとのワークフローは ref/local.md と ref/cloud.md に記載されています。コマンドを実行する前に、ユーザーの状況に合った方をお読みください。
使用するリファレンス
| ユーザーの目的 | 読むファイル |
|---|---|
| ClickHouse を使ったアプリの構築、ローカルでの開発やプロトタイプ作成。クラウドアカウントは不要 | ref/local.md |
| 本番環境への移行、マネージド ClickHouse のホスティング、または ClickHouse Cloud の明示的な利用 | ref/cloud.md |
| 既存のクラウドサービスの運用(スキーマ、ユーザー、サービスに対するクエリ) | ref/cloud.md |
| 今はローカルで開発し、後で本番環境にリリース | ref/local.md から始めてください。本番環境への移行時に ref/cloud.md を参照できます |
本当に判断が難しい場合(例:「アプリ用に ClickHouse をセットアップして」)は、開発タスクならローカルを既定とし、クラウド上に何かを作成する前に確認してください。クラウドサービスには費用がかかります。
前提条件(両方のワークフロー)
clickhousectl がインストールされていることを確認します。
which clickhousectl
見つからない場合は、インストールしてください。
curl -fsSL https://clickhouse.com/cli | sh
インストール先は ~/.local/bin/clickhousectl です(chctl エイリアスも利用できます)。コマンドがまだ見つからない場合は、export PATH="$HOME/.local/bin:$PATH" の実行、または新しいターミナルを開くよう提案してください。
すべてのコマンドで、機械可読な出力を得るための --json を指定できます。終了コードは gh の規則に準拠します。0 は成功、1 はエラー、2 はキャンセル、4 は認証が必要なことを示します。
関連項目
- スキーマを設計する際は、ORDER BY の選択、データ型、パーティショニングについて
clickhouse-best-practicesスキルを参照してください。 - Postgres(ローカル開発、またはマネージド ClickHouse Cloud Postgres)には、
infra-postgresスキルを使用してください。