mcpField
F
fallow-codex-onboarding

fallow-codex-onboarding

github.com/fallow-rs测试与质量13773 次安装今天更新
代码仓库

关于 fallow-codex-onboarding

fallow-codex-onboarding 是指导在 Codex 中配置和初次使用 Fallow 的 Skill,面向希望分析项目代码健康度的用户。它按步骤检查安装、设置分析范围并运行首次分析。

主要功能

  1. 01检查 Fallow CLI 安装状态
  2. 02逐项询问分析默认设置
  3. 03配置项目或变更文件分析范围
  4. 04运行首次代码健康分析
  5. 05说明仪表板与发现项的使用方式

适用场景

  1. 01在 Codex 中首次配置 Fallow
  2. 02选择全项目或分支变更分析
  3. 03查看首次分析结果并定位问题

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/fallow-rs/fallow-skills --skill fallow-codex-onboarding

安装后在 Claude Code 中输入/fallow-codex-onboarding确认已加载。

附带文件agents/openai.yaml

详细介绍

在 Codex 中设置 Fallow

使用 Fallow 应用工具。每个步骤都简短明了。每次只问一个问题。

1. 检查安装情况

使用 {} 调用 fallow_check_install。

  • 如果返回版本号,继续。
  • 如果缺少 fallow,说明该应用会在本地运行 fallow CLI,代码不会离开这台机器。询问用户是否要通过 npm install --global fallow 全局安装。侧边栏仪表板需要 PATH 中存在 fallow,因为应用只会在某个对话线程的 Codex 沙盒中,于项目内运行一份副本。只有用户同意后才运行安装。然后再次调用 fallow_check_install。

2. 选择默认设置

使用 {} 调用 fallow_settings_read。逐个询问以下问题。用户已回答的问题可跳过。

  1. “默认分析整个项目,还是只分析分支中已更改的文件?”将整个项目映射为 scope: "full",将已更改的文件映射为 scope: "changed"。
  2. “是否将测试、故事文件和开发工具排除在分析之外?”将“是”映射为 production: true。

使用仅包含已更改值的 set 对象调用 fallow_settings_update,例如 {"set":{"scope":"changed"}}。如果没有任何更改,则跳过调用。报告工具结果中保存的值。若调用失败,不要说该值已保存。

3. 运行首次分析

使用 {} 调用 fallow_analyze。用户会看到仪表板。用两到三句话说明健康度评分、发现问题最多的类别,以及一个可以优先处理的问题。

如果结果表明尚未关联项目,请让用户在此线程中打开一个项目文件夹,然后再次调用 fallow_analyze。

4. 展示应用提供的功能

用简短列表告诉用户:

  • 侧边栏中的 Fallow 可打开完整仪表板。
  • Code Health 会在对话线程旁打开,并跟踪该线程对应的项目。
  • 在输入框中输入 @Fallow,即可附加一项发现,或某条规则的所有发现。
  • 打开 .fallowrc.json 或 .fallowrc.jsonc,即可编辑规则,并在保存前预览其影响。.sarif 文件会在发现项查看器中打开。
  • 提交前,让 Codex 审查分支。

5. 提供下一步建议

如果项目没有 fallow 配置文件(.fallowrc.json、.fallowrc.jsonc、fallow.toml 或 .fallow.toml),则建议使用 fallow-setup 技能添加配置文件和 CI 门禁。如果用户在另一个任务中安装了插件,请在本次对话中继续该任务。

评论

支持 Markdown