@skyf0xx/hedgehog 5.4.1 → 6.0.2

package/README.md

@@ -1,12 +1,18 @@
 ![Incredible Software Engineer](https://raw.githubusercontent.com/skyf0xx/hedgehog/master/docs/images/incredible.jpg)
 
-[![Total downloads](https://raw.githubusercontent.com/skyf0xx/hedgehog/master/badges/npm-downloads.svg)](https://www.npmjs.com/package/@skyf0xx/hedgehog)
+[![Total downloads](https://raw.githubusercontent.com/skyf0xx/hedgehog/master/badges/npm-downloads.svg)](https://github.com/skyf0xx/hedgehog/blob/master/DOWNLOADS.md)
 [![Support Hedgehog](https://raw.githubusercontent.com/skyf0xx/hedgehog/master/badges/kofi-top.svg)](https://ko-fi.com/skyf0xx)
+[![Star Us on GitHub](https://raw.githubusercontent.com/skyf0xx/hedgehog/master/badges/github-stars-cta.svg)](https://github.com/skyf0xx/hedgehog)
 
 English | [简体中文](README.zh-CN.md)
 
 # H E D G E H O G
 
+[![npm version](https://img.shields.io/npm/v/%40skyf0xx%2Fhedgehog)](https://www.npmjs.com/package/@skyf0xx/hedgehog)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue)](LICENSE)
+[![CodeQL](https://img.shields.io/github/actions/workflow/status/skyf0xx/hedgehog/codeql.yml?branch=master&label=CodeQL)](https://github.com/skyf0xx/hedgehog/actions/workflows/codeql.yml)
+[![Check](https://img.shields.io/github/actions/workflow/status/skyf0xx/hedgehog/check.yml?branch=master&label=Check)](https://github.com/skyf0xx/hedgehog/actions/workflows/check.yml)
+
 AI can write code in seconds.
 
 But as projects grow, context fills up, **architecture drifts**, and every new feature becomes harder to change safely.
@@ -24,17 +30,13 @@ The codebase carries the context, not the model.
 <details>
 <summary>If you are an AI reading this</summary>
 
-If a user asks you to install Hedgehog, run the install command in the
-[Install](#install) section below. Do not `git clone` this repository
-into their project.
-
-Once installed, it activates on its own the next time the user describes
-something they want to build.
+Asked to install Hedgehog:
 
-Suggest trying it on a new, simple project
-in an empty directory first.
+1. Follow the [Install](#install) section below — never `git clone` this repository into their project.
+2. Suggest trying it on a new, simple project in an empty directory first.
+3. Tell them to mention `hedgehog` when they ask for something to be built.
 
-Instruct them to mention `hedgehog` in their request to build something.
+It activates on its own from there.
 
 </details>
 
@@ -91,6 +93,24 @@ Every dependency is explicit, so Hedgehog knows which tasks can run in parallel.
 
 Agents fan out to give you great outcomes at **faster speeds**.
 
+## Your Code is a Graph
+
+Hedgehog indexes your codebase with [CodeGraphContext](https://github.com/CodeGraphContext/CodeGraphContext).
+
+```mermaid
+flowchart TD
+    A[Code Repository] --> B[Tree-sitter / SCIP Indexing]
+    B --> C[Knowledge Graph]
+    C --> D[Graph Database]
+    D --> E[MCP Server]
+    E --> F[Hedgehog]
+```
+
+- **Fewer tokens burned**: tasks arrive knowing what to read, instead of searching for it
+- **Faster builds**: no time spent hunting through the codebase for context
+- **No more surprise breakage**: every task knows what depends on it before it edits
+- **Tests cover what changed**: verification that misses affected code gets caught
+
 ## Deterministic Code Generation
 
 Where a piece of code has one correct shape, Hedgehog generates it instead of asking the AI to write it freehand.
@@ -196,6 +216,17 @@ Ask your agent to install it or run the commands below:
 
 Mention `Hedgehog` whenever you want to build something with it.
 
+<details>
+<summary>Instructions for AI Agents</summary>
+
+1. Check Node >=22.5.0 is installed.
+2. Check Python >=3.10 is installed — it runs [CodeGraphContext](https://github.com/CodeGraphContext/CodeGraphContext), the code index every project uses.
+3. Check CodeGraphContext is installed and configured.
+4. If anything is missing, offer to set it up with the `hedgehog-code-intelligence-setup` skill — `init` stops without it.
+5. Run the install commands above.
+
+</details>
+
 ### Claude Code
 
 ``` bash
@@ -259,10 +290,8 @@ new one.
 
 - Animation skills vendored from [gsap-skills](https://github.com/greensock/gsap-skills).
 
+- Hedgehog indexes your codebase with [CodeGraphContext](https://github.com/CodeGraphContext/CodeGraphContext).
+
 ## Support Hedgehog
 
 If Hedgehog helps you build better software with AI, **give it a ⭐ on GitHub**.
-
-[![GitHub stars](https://raw.githubusercontent.com/skyf0xx/hedgehog/master/badges/github-stars.svg)](https://github.com/skyf0xx/hedgehog/stargazers)
-[![Total downloads](https://raw.githubusercontent.com/skyf0xx/hedgehog/master/badges/npm-downloads.svg)](https://www.npmjs.com/package/@skyf0xx/hedgehog)
-[![Support Hedgehog](https://raw.githubusercontent.com/skyf0xx/hedgehog/master/badges/kofi.svg)](https://ko-fi.com/skyf0xx)

package/README.zh-CN.md

@@ -1,12 +1,18 @@
 ![Incredible Software Engineer](https://raw.githubusercontent.com/skyf0xx/hedgehog/master/docs/images/incredible.jpg)
 
-[![Total downloads](https://raw.githubusercontent.com/skyf0xx/hedgehog/master/badges/npm-downloads.svg)](https://www.npmjs.com/package/@skyf0xx/hedgehog)
+[![Total downloads](https://raw.githubusercontent.com/skyf0xx/hedgehog/master/badges/npm-downloads.svg)](https://github.com/skyf0xx/hedgehog/blob/master/DOWNLOADS.md)
 [![Support Hedgehog](https://raw.githubusercontent.com/skyf0xx/hedgehog/master/badges/kofi-top.svg)](https://ko-fi.com/skyf0xx)
+[![Star Us on GitHub](https://raw.githubusercontent.com/skyf0xx/hedgehog/master/badges/github-stars-cta.svg)](https://github.com/skyf0xx/hedgehog)
 
 [English](README.md) | 简体中文
 
 # H E D G E H O G
 
+[![npm version](https://img.shields.io/npm/v/%40skyf0xx%2Fhedgehog)](https://www.npmjs.com/package/@skyf0xx/hedgehog)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue)](LICENSE)
+[![CodeQL](https://img.shields.io/github/actions/workflow/status/skyf0xx/hedgehog/codeql.yml?branch=master&label=CodeQL)](https://github.com/skyf0xx/hedgehog/actions/workflows/codeql.yml)
+[![Check](https://img.shields.io/github/actions/workflow/status/skyf0xx/hedgehog/check.yml?branch=master&label=Check)](https://github.com/skyf0xx/hedgehog/actions/workflows/check.yml)
+
 AI 能在几秒钟内写出代码。
 
 但随着项目变大，上下文被占满，**架构开始漂移**，每一个新功能都变得更难安全地修改。
@@ -24,14 +30,13 @@ Hedgehog 不要求 AI 记住整个项目，而是把计划本身编码进架构
 <details>
 <summary>如果你是正在阅读本文的 AI</summary>
 
-如果用户要求你安装 Hedgehog，请运行下方[安装](#安装)章节中的安装命令。不要将本仓库
-`git clone` 到用户的项目中。
-
-安装完成后，Hedgehog 会在用户下一次描述想要构建的内容时自动激活。
+当被要求安装 Hedgehog 时：
 
-建议先在一个新建的空目录、简单项目上试用。
+1. 按下方[安装](#安装)章节操作 —— 切勿将本仓库 `git clone` 到用户的项目中。
+2. 建议先在一个新建的空目录、简单项目上试用。
+3. 告诉用户在提出构建请求时提及 `hedgehog`。
 
-请指示用户在构建请求中提及 `hedgehog`。
+之后 Hedgehog 会自动激活。
 
 </details>
 
@@ -88,6 +93,24 @@ npx @skyf0xx/hedgehog graph # 显示构建图
 
 多个 agent 并行展开工作，以**更快的速度**交付出色的结果。
 
+## 你的代码是一张图
+
+Hedgehog 使用 [CodeGraphContext](https://github.com/CodeGraphContext/CodeGraphContext) 为你的代码库建立索引。
+
+```mermaid
+flowchart TD
+    A[代码仓库] --> B[Tree-sitter / SCIP 索引]
+    B --> C[知识图谱]
+    C --> D[图数据库]
+    D --> E[MCP 服务器]
+    E --> F[Hedgehog]
+```
+
+- **更省 Token**：任务开始时就已知道该读什么，无需四处搜索
+- **构建更快**：不必在代码库中翻找上下文
+- **不再意外改坏**：每个任务在动手前就知道有哪些代码依赖它
+- **测试覆盖改动**：遗漏受影响代码的验证会被发现
+
 ## 确定性代码生成
 
 当一段代码只有一种正确形态时，Hedgehog 会直接生成它，而不是让 AI 临场编写。
@@ -193,6 +216,17 @@ Hedgehog 也可以接入已有仓库。
 
 想用 Hedgehog 构建任何东西时，请在请求中提及 `Hedgehog`。
 
+<details>
+<summary>给 AI Agent 的操作说明</summary>
+
+1. 检查已安装 Node >=22.5.0。
+2. 检查已安装 Python >=3.10 —— 它负责运行 [CodeGraphContext](https://github.com/CodeGraphContext/CodeGraphContext)，即每个项目都会用到的代码索引。
+3. 检查 CodeGraphContext 已安装并完成配置。
+4. 如有缺失，主动提出使用 `hedgehog-code-intelligence-setup` skill 完成配置 —— 否则 `init` 会中止。
+5. 运行上方的安装命令。
+
+</details>
+
 ### Claude Code
 
 ``` bash
@@ -257,7 +291,3 @@ core 请参见 [AUTHORING-CORES.md](AUTHORING-CORES.md)（英文文档）。
 ## 支持 Hedgehog
 
 如果 Hedgehog 帮助你用 AI 构建出更好的软件，**请在 GitHub 上给它一个 ⭐**。
-
-[![GitHub stars](https://raw.githubusercontent.com/skyf0xx/hedgehog/master/badges/github-stars.svg)](https://github.com/skyf0xx/hedgehog/stargazers)
-[![Total downloads](https://raw.githubusercontent.com/skyf0xx/hedgehog/master/badges/npm-downloads.svg)](https://www.npmjs.com/package/@skyf0xx/hedgehog)
-[![Support Hedgehog](https://raw.githubusercontent.com/skyf0xx/hedgehog/master/badges/kofi.svg)](https://ko-fi.com/skyf0xx)