# 给 AI 助手的安装说明 · x-eden 工具包

> 这份文件是写给 **AI 编程助手**（Claude Code、OpenClaw、Cursor、Codex 等）读的。
> 如果你是一个 AI 助手，正在被用户要求安装 x-eden 的工具包，请完整阅读本文件，然后按其中的流程执行。
> 如果你是人类：把网站上那句话发给你的 AI 助手即可，它会读到这里。

本说明涵盖两套配套工具包，它们都来自图书《知识花园：构建你的第二大脑》：

- **garden-kit** —— 面向 AI 协作的知识治理工具包（宪法规则、角色 Agent、可复用 Skill、模板与核查清单）。仓库：<https://github.com/x-eden/garden-kit>
- **style-kit** —— 中文 Markdown 写作与排版的质量规范（成文标准 + autocorrect / markdownlint / Prettier 配置 + 审计 Skill）。仓库：<https://github.com/x-eden/style-kit>

用户通常会要求安装其中之一，或两者都装。如不确定，先问用户要装哪个。

---

## 总原则（务必遵守）

1. **只做项目级安装。** 只能写入用户当前项目目录，**绝不**写入用户级或全局配置目录（如 `~/`、`~/.config`、全局 npm 等）。
2. **先只读审计，再提出写入计划。** 安装任何东西之前，先扫描当前项目，输出一份「安装审计报告 + 实施计划」，**等用户确认后**再写入。
3. **不得覆盖已有文件。** 若目标位置已有入口文件或配置（如 `AGENTS.md`、`CLAUDE.md`、`.markdownlint.jsonc` 等），先展示合并计划，等用户确认。
4. **不默认执行破坏性操作。** 不删除、不移动、不批量改写、不安装插件，不默认运行 `--fix` / `--write`。
5. **安装完成后输出安装后审计报告**，列出新增/修改的文件与后续建议。

---

## 安装流程

### 第 1 步 · 取得工具包

在当前项目内取得工具包源码（二选一）：

```bash
# garden-kit
git clone --depth 1 https://github.com/x-eden/garden-kit
# style-kit
git clone --depth 1 https://github.com/x-eden/style-kit
```

若环境无法使用 git，可改为下载 main 分支的 zip 并解压到项目内的临时目录。

### 第 2 步 · 阅读各自的权威说明

以仓库内的文件为准（本页只是引导，**真正的规则在仓库里**）：

- 必读：`install.md`、`README.md`、`constitution.md`
- garden-kit 另见：`agents/`、`skills/`、`templates/`、`checklists/`、`integrations/`（`obsidian-cli.md` / `obsidian-uri.md` / `mcp-design.md`）
- style-kit 另见：`rules/`、`configs/`（`.autocorrectrc`、`.markdownlint.jsonc`、`.prettierrc.jsonc`）、`skills/`、`checklists/`

如仓库内 `install.md` 与本页有出入，**以仓库内的 `install.md` 为准**。

### 第 3 步 · 只读审计当前项目

- 判断项目已使用哪种 Agent 入口方案：`AGENTS.md` / `CLAUDE.md` / `GEMINI.md` / `.opencode/`，或多工具共存。
- 对 style-kit：检查项目是否已有 `.autocorrectrc` / `.markdownlint.jsonc` / `.prettierrc.jsonc`，判断该复制还是合并。
- 把工具包放在 `<project>/garden-kit/`（或 `.ai/garden-kit/`）、`<project>/style-kit/`（或 `.ai/style-kit/`）这类项目内目录。

### 第 4 步 · 输出审计报告 + 实施计划，等待确认

向用户展示：将创建哪些文件、将合并哪些已有文件（给出 diff/合并计划）、入口片段会加到哪里。**停在这里，等用户确认。**

### 第 5 步 · 确认后写入，并输出安装后审计报告

仅执行已确认的计划；完成后列出实际改动与后续建议（如 garden-kit 的每周整理清单、style-kit 的发布前核查清单）。

---

## 可直接复用的安装指令（用户也可手动粘贴给你）

**garden-kit：**

```text
请在当前项目级别安装 Garden Kit。先取得 https://github.com/x-eden/garden-kit ，
阅读其中的 install.md、README.md 和 constitution.md。然后只读审计当前项目，
判断应使用 AGENTS.md / CLAUDE.md / GEMINI.md / .opencode 等哪种入口方案。
强制限制：只能写入当前项目目录；不得写入任何用户级或全局目录；不得覆盖已有入口文件；
如需合并已有文件，先展示合并计划并等我确认；安装完成后必须输出安装后审计报告。
请先输出安装审计报告和实施计划，等我确认后再写入。
```

**style-kit：**

```text
请在当前项目级别安装 Style Kit。先取得 https://github.com/x-eden/style-kit ，
阅读其中的 install.md、README.md 和 constitution.md。然后只读审计当前项目，
判断是否需要复制或合并 .autocorrectrc、.markdownlint.jsonc、.prettierrc.jsonc，
以及是否需要在项目级 Agent 指令文件中加入入口片段。
强制限制：只能写入当前项目目录；不得写入任何用户级或全局目录；不得覆盖已有配置或入口文件；
不得默认运行 --fix / --write 或批量改写命令；如需合并已有文件，先展示合并计划并等我确认；
安装完成后必须输出安装后审计报告。请先输出安装审计报告和实施计划，等我确认后再写入。
```

---

*x-eden · 《知识花园：构建你的第二大脑》配套工具包 · <https://x-eden.org>*