mcpField
I
infra-clickhouse

infra-clickhouse

github.com/clickhouse云与 DevOps5624.5k 次安装1 周前更新
代码仓库

关于 infra-clickhouse

infra-clickhouse 是指导 Agent 使用 clickhousectl 管理本地 ClickHouse 和 ClickHouse Cloud 的技能,按开发或生产场景指向相应操作流程。

主要功能

  1. 01区分本地与云端工作流
  2. 02指导选择对应参考文档
  3. 03涵盖开发到生产的路径
  4. 04提供命令行安装说明
  5. 05支持 JSON 输出说明

适用场景

  1. 01为应用搭建本地 ClickHouse
  2. 02创建或运维 ClickHouse Cloud 服务
  3. 03从本地开发转向生产部署

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/clickhouse/agent-skills --skill infra-clickhouse

安装后在 Claude Code 中输入/infra-clickhouse确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

metadata.json
README.md
ref/
cloud.md
local.md

详细介绍

使用 clickhousectl 管理 ClickHouse

clickhousectl 可在两种环境中管理 ClickHouse:

  • 本地 — 在用户的计算机上安装并运行 ClickHouse,用于开发。
  • 云端 — 由 ClickHouse Cloud 托管的服务,用于生产环境:全托管、自动扩缩容、备份和升级。

本文件会引导你查阅合适的参考文档。分步工作流位于 ref/local.md 和 ref/cloud.md 中——运行命令前,请先阅读与用户情况相符的文档。

选择要查阅的参考文档

用户想要……阅读
使用 ClickHouse 构建应用,在本地开发或制作原型,无需云账户ref/local.md
将应用投入生产、托管 ClickHouse 服务,或明确使用 ClickHouse Cloudref/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 表示需要身份验证。

相关内容

  • 设计架构时,请查阅 clickhouse-best-practices 技能,了解 ORDER BY 的选择、数据类型和分区。
  • 对于 Postgres(本地开发或由 ClickHouse Cloud 托管的 Postgres),请使用 infra-postgres 技能。

评论

支持 Markdown