Claudate/project-multilevel-index

Registry 信息

项目简介

Project Multilevel Index 是一个受《哥德尔、埃舍尔、巴赫》启发的分形自指文档系统。它能自动维护代码索引、文件头与依赖关系图。该 Claude Skill 支持 Claude Code 全自动模式，并为 VSCode、Cursor、Windsurf 和 Kiro 开发扩展。

要点

• 分形自指文档系统
• 自动维护代码索引和文件头
• 生成并更新依赖关系图
• 支持 Claude Code 全自动模式
• 为流行编辑器开发扩展

使用场景

• 自动化代码库文档
• 维护项目依赖可视化
• 保持文件头和索引同步
• 增强AI辅助开发工作流
• 支持复杂项目导航

README 摘要

# 项目多级索引系统 (Project Multi-level Index) <div align="center"> <img src="public/book.jpg" alt="哥德尔、埃舍尔、巴赫" width="300"> > 受《哥德尔、埃舍尔、巴赫》启发的分形自指文档系统 > > 让代码项目如赋格曲般自我指涉、自我维护、优雅和谐 [](https://github.com/Claudate/project-multilevel-index/releases) [](docs/development/I18N_GUIDE.md) [](LICENSE) [](https://claude.ai/code) [](docs/development/CONTRIBUTING.md) **🌐 多平台代码文档自动化系统** CLI工具 + Claude Code插件 + VSCode扩展 [简体中文](#) | [English](README_EN.md) | [📖 文档导航](#-文档导航) </div> --- ## 📖 核心理念 **三级分形文档系统** - 自动维护项目的索引和依赖关系： ``` PROJECT_INDEX.md (根索引) ├─ 项目概览、架构说明 ├─ 目录结构导航 └─ Mermaid 依赖关系图 每个文件夹/ └─ FOLDER_INDEX.md (文件夹索引) ├─ 架构说明 ├─ 文件清单 └─ "本文件夹变化时，更新我" 每个文件 └─ 文件头注释 ├─ Input: 依赖什么 ├─ Output: 提供什么 ├─ Pos: 在系统中的定位 └─ "我被更新时，更新我的注释和索引" ``` ### 三大特性 - **🔄 自相似性**：每个层级都有相同的索引结构 - **🪞 自指性**：每个文档都声明"当我变化时，更新我" - **🎼 复调性**：代码与文档相互呼应，局部影响整体 --- ## 🚀 快速开始 ### 方法 1: CLI 工具 `codex`（推荐用于 CI/CD） **独立命令行工具** - 不依赖任何编辑器： ```bash # 1. 克隆并安装 git clone https://github.com/Claudate/project-multilevel-index.git cd project-multilevel-index/cli npm install && npm run build && npm link # 2. 使用 cd /your/project codex init ``` **输出示例**: ``` 🎼 Fractal Multi-level Index System ✔ Found 45 code files ✔ Generated 45 file headers ✔ Generated 8 folder indexes ✔ Generated PROJECT_INDEX.md ✅ Index system initialized successfully! ``` 📖 [CLI完整文档](cli/README.md) | [实现说明](docs/development/CLI_IMPLEMENTATION.md) --- ##

话题

暂无话题