# project-info-manager

> Maintain and manage AI-readable project metadata in a per-repo `.project/` folder (project.json + overview.md) with scripts for init/read/update/validate/format/render and incremental updates based on git commits since updated_at. Use when Codex needs to create/update `.project` info or answer questions about a repository’s overview/stack/architecture (including Chinese requests like “项目信息/项目概况/技术栈/项目架构/根据 git 提交更新”).

- Author: Drunk-Dream
- Repository: Drunk-Dream/codex-skills
- Version: 20260102234916
- Stars: 1
- Forks: 0
- Last Updated: 2026-02-07
- Source: https://github.com/Drunk-Dream/codex-skills
- Web: https://mule.run/skillshub/@@Drunk-Dream/codex-skills~project-info-manager:20260102234916

---

---
name: project-info-manager
description: Maintain and manage AI-readable project metadata in a per-repo `.project/` folder (project.json + overview.md) with scripts for init/read/update/validate/format/render and incremental updates based on git commits since updated_at. Use when Codex needs to create/update `.project` info or answer questions about a repository’s overview/stack/architecture (including Chinese requests like “项目信息/项目概况/技术栈/项目架构/根据 git 提交更新”).
---

# Project Info Manager

## Overview

在项目根目录维护统一的 `.project/` 项目信息目录，并用脚本完成基础 CRUD 与常用维护动作（初始化、读取、更新、校验、格式化、渲染 overview），支持基于 git 增量更新（从 `updated_at` 之后的提交记录推导需要更新的项目信息）。

## Canonical Data

- `(.project/)project.json` 是唯一结构化真源（source of truth）。
- `(.project/)overview.md` 为派生/缓存文件，可随时重新生成并覆盖。

## Schema

需要字段含义/新增字段时，阅读 `references/memory-schema.md`。

## Workflow (default)

1. 检查项目根目录是否存在 `.project/project.json`；不存在则初始化。
2. 通过脚本更新字段或人工编辑 `project.json`；随后格式化并校验。
3. 渲染 `overview.md` 供 AI/人类快速浏览。

## Workflow (update-from-git)

当用户要求“根据 git 提交记录更新项目信息”时：

1. 从 `.project/project.json` 读取 `updated_at`（上次维护项目信息的时间）。
2. 获取 `updated_at` 之后的所有提交记录：运行 `python3 <skill_root>/scripts/project_info_git_commits.py`。
3. 基于提交记录更新 `project.json`（必要时结合代码/目录变更阅读关键文件），然后格式化+校验+渲染。

## Scripts

在目标项目根目录下执行（或用 `--project-root <path>` 指定）：

- 初始化（Create）：`python3 <skill_root>/scripts/project_info_init.py`
- 读取（Read）：`python3 <skill_root>/scripts/project_info_read.py --format markdown`
- 增量提交记录（Git）：`python3 <skill_root>/scripts/project_info_git_commits.py`
- 更新（Update）：`python3 <skill_root>/scripts/project_info_update.py --set project.summary=\"...\" --set architecture.overview=\"...\"`
- 删除（Delete，危险）：`python3 <skill_root>/scripts/project_info_delete.py --yes`
- 校验：`python3 <skill_root>/scripts/project_info_validate.py [--strict]`
- 格式化：`python3 <skill_root>/scripts/project_info_format.py`
- 渲染 overview：`python3 <skill_root>/scripts/project_info_render.py`

其中 `<skill_root>` 为本 `SKILL.md` 所在目录。