HardMax71/amiss
GitHub: HardMax71/amiss
Amiss 是一款文档引用一致性检查工具,通过比照仓库结构树来发现文档中失效或过时的文件引用。
Stars: 1 | Forks: 0
Amiss
Amiss 会根据文档描述的结构树来检查文档。它会读取仓库中的文档,跟踪这些文档中对同一仓库的引用,并在引用失效,或者引用背后的文件已更改而周围的文字却没有更改时进行报告。它读取的是结构,而不是含义:它不会告诉你某个句子的真假,也不会进行猜测。 它不保留任何状态,不执行任何操作,从不接触网络,也从不进行写入;通过同一个引擎二进制文件处理的相同输入会产生逐字节相同的报告。在 `enforce` 模式下,无法解析的引用会导致运行失败;在未更改的段落下发生的文件更改始终是对人类的提示,绝不是机器的裁决。 ``` cargo install amiss amiss check --repo . --object-format sha1 \ --base "$(git rev-parse HEAD~1)" --candidate "$(git rev-parse HEAD)" \ --profile observe ``` 在 CI 中,同一个引擎以 action 的形式发布,该 action 会从事件中提取两个 commit,并在 pull request 上对发现的问题进行标注: ``` - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 with: fetch-depth: 2 - uses: HardMax71/amiss@v0 with: profile: observe ``` 从 `observe` 模式开始,这样就可以在不阻塞 pull request 的情况下对发现的问题进行分类处理;不完整或不受信任的运行仍然会失败。在审查了最初的积压问题和仓库策略后,将输入切换为 `enforce`。 代码编写 Agent 会得到与人类相同的待遇:每个发现和错误行都包含一句话,说明其含义以及该怎么做;被拒绝的调用会打印出完整的语法规则;此外,该书的[与 Agent 协作](https://hardmax71.github.io/amiss/agents.html)章节中提供了一个可以直接粘贴到你仓库 `AGENTS.md` 中的代码块。你可以通过一次请求在 [llms.txt](https://hardmax71.github.io/amiss/llms.txt) 获取本书内容,或者在 [llms-full.txt](https://hardmax71.github.io/amiss/llms-full.txt) 获取完整版。 其他所有内容均在[文档](https://hardmax71.github.io/amiss/)中。分发条款和第三方声明请参见[许可证](LICENSE.md)和[声明](THIRD_PARTY_NOTICES.md)。标签:LNA, Rust, SOC Prime, 可视化界面, 开发工具, 文档检查, 网络流量审计, 通知系统