SuperAPI AI 工具集

nav-init

办公与效率

查看项目

更新于 10-25 16:17

技能介绍

用途

nav-init 是 Navigator 插件提供的初始化技能,作用是在新项目中建立 Navigator 的文档结构(.agent/),复制模板并完成初始配置。它会在用户说出“Initialize Navigator in this project”“Set up Navigator documentation structure”“Create .agent folder for Navigator”“Bootstrap Navigator for my project”等指令时自动调用。该技能替代了 v2.x 中已删除的 /nav:init 命令。

主要能力

  • 检查是否已初始化:若 .agent 目录已存在,则提示“Navigator already initialized”,不会覆盖现有结构,可安全重复运行。
  • 创建目录结构:.agent/ 下包含 DEVELOPMENT-README.md、.nav-config.json,以及 tasks/、system/、sops/(含 integrations、debugging、development、deployment 子目录)、grafana/。
  • 复制并定制模板:将插件 templates/ 目录中的 DEVELOPMENT-README.md 复制到 .agent/,替换 ${PROJECT_NAME}、${TECH_STACK}、${DATE} 等占位符;生成 .nav-config.json(包含 version、project_name、tech_stack、project_management、task_prefix、team_chat、auto_load_navigator、compact_strategy、auto_update 等字段)。
  • 自动识别项目信息:按顺序读取 package.json、pyproject.toml、go.mod、Cargo.toml、composer.json、Gemfile,提取项目名称、技术栈与依赖;找不到配置文件时回退为当前目录名。
  • Grafana 监控文件:从插件安装目录复制 docker-compose.yml、prometheus.yml、grafana-datasource.yml、grafana-dashboards.yml、navigator-dashboard.json 和 README.md 到 .agent/grafana/,用于指标可视化。
  • 更新 CLAUDE.md:若已存在则追加 Navigator 相关章节并保留原有定制;若不存在则复制模板并填入项目信息。
  • 维护 .gitignore:添加 .context-markers/ 与 .agent/.nav-temp/ 等临时文件排除项。

使用方式

安装 Navigator 插件后,在项目中说“Initialize Navigator in this project”等触发语句即可。初始化完成后可按提示执行“Start my Navigator session”开始会话,阅读 .agent/DEVELOPMENT-README.md 查看文档;如需监控指标,可参考 .agent/sops/integrations/opentelemetry-setup.md,或进入 .agent/grafana 执行 docker compose up -d 启动 Grafana。

钩子说明

自 v6.13.0 起,Navigator 的生命周期钩子随插件清单(.claude-plugin/plugin.json 的顶层 hooks 字段)一起分发,不再合并进项目的 .claude/settings.json。插件安装后自动注册的钩子包括:SessionStart(注入 Navigator 上下文)、PreCompact / PostCompact(压缩前后写入与追加上下文标记)、Stop(记录工作流状态)、UserPromptSubmit(提示门控与意图简报注入)、PreToolUse(Read)(批量读取熔断)、PostToolUse(Edit|Write|Bash)(上下文用量 70% / 85% 警告)、PostToolUse(Edit|Write)(任务与图谱同步、配置修正同步)。插件安装或更新后需重启以激活钩子。用户可在 .agent/.nav-config.json 中通过 session_start_hook、compact_hook、workflow_state_hook、task_graph_sync_hook、profile_sync_hook、workflow_enforcer_hook 的 enabled 字段关闭对应钩子,钩子会读取配置并短路,无需修改 settings.json。nav-init 本身不再写入钩子配置。

适用场景

适用于首次为项目引入 Navigator 文档与工作流体系,例如新建的 Next.js 项目(识别出 next、typescript、prisma 依赖)或 Python 项目(识别出 fastapi、pydantic、sqlalchemy 依赖)。nav-start、nav-task、nav-sop 等技能依赖此初始化结果:nav-start 会检查 .agent/DEVELOPMENT-README.md,若缺失则提示先初始化;nav-task 与 nav-sop 也需要已初始化才能在对应目录创建内容。

限制

  • 已存在 .agent 目录时不会覆盖,只给出提示。
  • 模板缺失时提示重新安装插件;无写入权限时报错无法创建目录。
  • 项目信息识别为尽力而为,找不到配置文件时回退为目录名。
  • 插件安装或更新后必须重启才能激活钩子。
  • 具体平台兼容性、收费与价格信息暂未提供。