@apparux/agent-init
v0.1.3-rc.2
Published
简体中文 | [English](./docs/README.en.md)
Downloads
449
Readme
Agent Init
简体中文 | English
Agent Init 为 Claude Code 和 Codex 安装一个共享的 agent-init Skill。该 Skill 会进入现有仓库,收集证据,提出最小化的 Agent 环境方案,并且仅在获得明确批准后写入文件。
状态:v0.1.2。
许可证:MIT。
从 @apparux/agent-project-setup 迁移
本包原名 @apparux/agent-project-setup,现已更名为 @apparux/agent-init。旧包已弃用,不再接收更新。新旧包使用不同的安装根目录,新包不会自动迁移旧安装,请按以下顺序迁移:
# 1. 安装新包(若提示目标已存在,先执行第 2 步再重试本命令)
npx @apparux/agent-init@latest install
# 2. 卸载旧包
npx @apparux/agent-project-setup@latest uninstall说明:
- 第 2 步卸载旧包时,可能列出
Preserved及~/.claude/skills/project-setup、~/.agents/skills/project-setup等条目并带!标记。这是预期行为,不是异常:这些路径由旧包创建,旧包拒绝删除所有权证据不匹配的内容。两步完成后,若这些project-setup条目仍存在,请手动删除(新包安装的是agent-init路径,不会接管旧路径)。 - 若卸载后确实留下了指向
~/.agent-project-setup/的悬空符号链接(可用ls -la ~/.claude/skills确认),先删除它们再执行第 1 步。
环境要求
- Node.js 18 或更高版本
- Linux、macOS 或 WSL
- Windows Native 提供尽力支持,并可能使用托管副本回退方案
安装
推荐使用 npx,无需全局安装包:
npx @apparux/agent-init@latest install安装器会将规范母 Skill 复制到以下稳定位置:
~/.agent-init/current/skills/agent-init随后,它会向两个 Harness 暴露同一个规范 Skill:
~/.agents/skills/agent-init
~/.claude/skills/agent-init安装器会优先使用符号链接。如果无法创建稳定且可验证所有权的符号链接,则可以改用托管副本,并在 install.json 中记录该模式。
安装完成后:
- Claude Code:
/agent-init - Codex:
$agent-init
CLI
使用最新包负载执行生命周期操作:
npx @apparux/agent-init@latest install
npx @apparux/agent-init@latest update
npx @apparux/agent-init@latest doctor
npx @apparux/agent-init@latest uninstall
npx @apparux/agent-init@latest --version
npx @apparux/agent-init@latest --help如果该包是全局安装的,运行 agent-init update 只会应用当前已安装包的负载。若要获取最新发布的负载,请使用 npx @apparux/agent-init@latest update,或先更新全局包。
install
创建稳定的规范安装以及 Claude/Codex 发现目标。对同一健康版本重复执行安装时不会产生变更。安装器绝不会覆盖未知目标。
update
仅更新由本安装器拥有的用户级母 Skill 和目标,不会扫描或修改当前仓库。同一版本、同一负载且安装健康时,会报告已是最新状态;遇到降级或完整性冲突时,会停止操作且不替换用户数据。
doctor
以只读方式检查 manifest、规范 Skill、所有权证据、目标模式和目标内容,不会自动修复文件。
uninstall
仅删除仍能证明由本安装器拥有的用户级资源。已被替换、发生漂移或存在歧义的目标会被保留并报告。通过 agent-init 创建的项目文件始终不会被卸载操作删除。
项目设置工作流
/agent-init 和 $agent-init 在当前仓库中运行,与 CLI 的 update 操作相互独立:
- 预检和只读探索
- 项目画像和证据账本
- 知识分类
- 项目特定工作流检测
- 展示精确创建、更新、保留、跳过和建议操作的方案
- 用户明确批准
- 限定范围的应用和验证
未经明确批准,Skill 不会修改仓库。如果方案提出后目标发生变化,原批准将失效,必须重新生成方案。
默认情况下,Skill 只能对以下路径提出变更方案:
AGENTS.md
CLAUDE.md
.agents/
.claude/
docs/agents/它不会修改业务源码、构建 manifest、CI、数据库或生产配置。在 v0.1 中,护栏和架构改进仅作为建议:Skill 不会安装 hooks、更改权限、编辑 CI 或重构生产代码。
缺乏充分仓库证据的事实会保持为 Unknown。现有 Agent 文件和 Skills 会被读取并保守协调,而不是被删除后重新生成。
生成的目录结构
仓库只会获得由证据支持的资源。典型结果如下:
AGENTS.md 共享的最小规则
CLAUDE.md 导入 @AGENTS.md 的轻量适配器
.agents/skills/<name>/SKILL.md 规范的项目工作流
.claude/skills/<name> 指向规范工作流的引用
docs/agents/ 可选的长期架构指南仅检测到技术栈不会创建 Skill。项目 Skill 必须对应一个重复出现、项目特定且具有明确触发条件和验证方式的工作流。
安全模型
- 安装测试和生命周期检查使用隔离的临时 HOME。
- 修改前会验证所有托管路径。
- 不会仅因内容相似就接管未知文件或链接。
- Doctor 严格保持只读。
- 卸载不会搜索仓库路径,也不会删除发现目标的父目录。
- 项目应用必须经过方案批准,并且只能修改已批准的路径。
- 凭证和仓库 Secret 不会写入
install.json或生成的 Agent 资源。
开发
npm test
npm pack --dry-run测试使用 Node 内置测试运行器,无需构建步骤。发布验收还要求通过确定性的 Skill 契约和 fixture 验证、受支持平台验证、许可证决策、registry 授权以及明确的发布决策。登录 Claude Code 或 Codex 并不是发布门禁。
