issuekit 0.1.4__tar.gz → 0.1.5__tar.gz

{issuekit-0.1.4 → issuekit-0.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: issuekit
-Version: 0.1.4
+Version: 0.1.5
 Summary: AI 辅助开发的 Issue 全生命周期工具。从需求分析到代码审核，由你的 AI 编程助手驱动。
 Project-URL: Homepage, https://github.com/xsg22/issue-kit
 Project-URL: Repository, https://github.com/xsg22/issue-kit
@@ -132,6 +132,26 @@ $issuekit-review    # 多维度代码审核
 
 每个 Skill 包含 `SKILL.md`（指令）和 `agents/openai.yaml`（元数据）。
 
+## 更新模板与 Skills（已 init 的项目）
+
+文档模板与 Skills 都来自 **已安装的 `issuekit` PyPI 包**。要拿到新版内容，先升级包，再同步到项目：
+
+```bash
+pip install -U issuekit
+issuekit upgrade --ai cursor    # 与 init 时选的助手一致：cursor / claude / codex / copilot
+```
+
+`upgrade` 会：
+
+- **覆盖** `.issuekit/templates/` 下与内置同名的 `.md`（若你改过模板，请先备份或自行合并）；
+- **覆盖** 各 AI Skills 目录下的 `issuekit-*`（如 `.cursor/skills/`）。
+
+**不会** 修改 `.issuekit/config.yaml`、`.issuekit/knowledge/config.yaml`，也不会删除 `.issuekit/knowledge/` 里已生成的知识摘要文件。
+
+若你曾用 `issuekit init --issues-dir` 自定义过 Issue 目录，无需再改；`upgrade` 不涉及该配置。
+
+> **不建议** 用 `issuekit init --force` 仅为了更新：`--force` 会**整目录删除** `.issuekit/` 并重建，可能丢失知识库配置与 `.issuekit/knowledge/` 下已生成的摘要。
+
 ## 支持的 AI 助手
 
 

{issuekit-0.1.4 → issuekit-0.1.5}/README.md

@@ -103,6 +103,26 @@ $issuekit-review    # 多维度代码审核
 
 每个 Skill 包含 `SKILL.md`（指令）和 `agents/openai.yaml`（元数据）。
 
+## 更新模板与 Skills（已 init 的项目）
+
+文档模板与 Skills 都来自 **已安装的 `issuekit` PyPI 包**。要拿到新版内容，先升级包，再同步到项目：
+
+```bash
+pip install -U issuekit
+issuekit upgrade --ai cursor    # 与 init 时选的助手一致：cursor / claude / codex / copilot
+```
+
+`upgrade` 会：
+
+- **覆盖** `.issuekit/templates/` 下与内置同名的 `.md`（若你改过模板，请先备份或自行合并）；
+- **覆盖** 各 AI Skills 目录下的 `issuekit-*`（如 `.cursor/skills/`）。
+
+**不会** 修改 `.issuekit/config.yaml`、`.issuekit/knowledge/config.yaml`，也不会删除 `.issuekit/knowledge/` 里已生成的知识摘要文件。
+
+若你曾用 `issuekit init --issues-dir` 自定义过 Issue 目录，无需再改；`upgrade` 不涉及该配置。
+
+> **不建议** 用 `issuekit init --force` 仅为了更新：`--force` 会**整目录删除** `.issuekit/` 并重建，可能丢失知识库配置与 `.issuekit/knowledge/` 下已生成的摘要。
+
 ## 支持的 AI 助手
 
 

{issuekit-0.1.4 → issuekit-0.1.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "issuekit"
-version = "0.1.4"
+version = "0.1.5"
 description = "AI 辅助开发的 Issue 全生命周期工具。从需求分析到代码审核，由你的 AI 编程助手驱动。"
 requires-python = ">=3.10"
 license = "MIT"

{issuekit-0.1.4 → issuekit-0.1.5}/src/issuekit/__init__.py

@@ -1,3 +1,3 @@
 """IssueKit - AI 辅助开发的 Issue 全生命周期工具。"""
 
-__version__ = "0.1.4"
+__version__ = "0.1.5"

{issuekit-0.1.4 → issuekit-0.1.5}/src/issuekit/bundled_skills/issuekit-knowledge/SKILL.md

@@ -111,7 +111,7 @@ description: 分析当前项目，生成结构化的上下文知识摘要到 .is
 - 日志使用方式
 - 错误处理模式
 - 如果项目已有规范文件（如 .cursor/rules/, .editorconfig, linter 配置），整合其内容
-- 增加"Agent 使用提示"小节：执行任何任务前，先阅读 `.issuekit/knowledge/` 中与任务相关的已有知识；若存在 `.issuekit/knowledge/modules/` 对应模块文件，优先阅读模块文件，再补充全局知识，然后再开始任务规划
+- 执行任务前，先阅读 `.issuekit/knowledge/` 中与任务相关的已有知识；若存在 `.issuekit/knowledge/modules/` 对应模块文件，优先阅读模块文件，再补充全局知识，然后再开始任务规划
 
 ### 第 7.5 步：模块知识文件（仅模块模式）
 

{issuekit-0.1.4 → issuekit-0.1.5}/src/issuekit/cli.py

@@ -14,6 +14,7 @@ if sys.stdout.encoding and sys.stdout.encoding.lower() != "utf-8":
 import typer
 
 from issuekit.commands.init import init as init_cmd
+from issuekit.commands.upgrade import run_upgrade
 from issuekit.agents import AGENT_REGISTRY
 
 SUPPORTED_AI = ", ".join(AGENT_REGISTRY.keys())
@@ -88,6 +89,24 @@ def init(
     init_cmd(ai=ai, issues_dir=issues_dir, here=here, force=force)
 
 
+@app.command("upgrade")
+def upgrade(
+    ai: str = typer.Option(
+        ...,
+        "--ai",
+        help=f"与 init 时一致：{SUPPORTED_AI}",
+    ),
+):
+    """将当前已安装 issuekit 包内的文档模板与 Skills 同步到项目。
+
+    会覆盖 .issuekit/templates/ 下同名 .md，并覆盖各 AI Skills 目录下的 issuekit-* 内容；
+    不修改 .issuekit/config.yaml、.issuekit/knowledge/ 下的知识摘要等。
+
+    先执行 pip install -U issuekit，再运行本命令。
+    """
+    run_upgrade(ai=ai)
+
+
 @app.command("version")
 def version():
     """显示 IssueKit 版本号。"""

issuekit-0.1.5/src/issuekit/commands/upgrade.py

@@ -0,0 +1,57 @@
+"""issuekit upgrade — 同步 bundled 文档模板与 Skills。"""
+
+from pathlib import Path
+
+import typer
+from rich.console import Console
+
+from issuekit.agent_skills import install_agent_skills
+from issuekit.agents import AGENT_REGISTRY, get_agent_config
+from issuekit.templates import copy_templates
+
+console = Console()
+OK = "[green]+[/green]"
+SUPPORTED_AI = ", ".join(AGENT_REGISTRY.keys())
+ISSUEKIT_DIR = ".issuekit"
+
+
+def run_upgrade(*, ai: str) -> None:
+    agent_config = get_agent_config(ai)
+    if not agent_config:
+        console.print(
+            f"[red]错误:[/red] 不支持的 AI 助手 '{ai}'\n"
+            f"[dim]支持的选项:[/dim] {SUPPORTED_AI}"
+        )
+        raise typer.Exit(1)
+
+    project_path = Path.cwd()
+    issuekit_path = project_path / ISSUEKIT_DIR
+    if not issuekit_path.is_dir():
+        console.print(
+            f"[red]错误:[/red] 当前目录下没有 {ISSUEKIT_DIR}/，请先在本项目执行 "
+            f"[cyan]issuekit init --ai {ai}[/cyan]"
+        )
+        raise typer.Exit(1)
+
+    templates_path = issuekit_path / "templates"
+    templates_path.mkdir(parents=True, exist_ok=True)
+    console.print(
+        "[yellow]注意:[/yellow] 将覆盖 [cyan].issuekit/templates/[/cyan] 中与内置同名的 .md 模板。"
+    )
+    tpl_count = copy_templates(templates_path)
+    console.print(
+        f"{OK} 已从当前 issuekit 安装包同步 {tpl_count} 个模板到 "
+        f"[cyan]{ISSUEKIT_DIR}/templates/[/cyan]"
+    )
+
+    skills_dir = project_path / agent_config.skills_dir
+    skills_dir.mkdir(parents=True, exist_ok=True)
+
+    install_count = install_agent_skills(
+        skills_dir,
+        include_openai_yaml=agent_config.has_openai_yaml,
+    )
+    console.print(
+        f"{OK} 已从当前 issuekit 安装包同步 {install_count} 个 Skill 到 "
+        f"[cyan]{agent_config.skills_dir}/[/cyan]"
+    )