KeygraphHQ/shannon：README 来源编辑指南

KeygraphHQ/shannon 的 README 将项目描述为"Shannon is an AI pentester for web applications and APIs. It analyzes your source code, identifies attack vectors, and executes real exploits to prove vulnerabilities before they reach production."。本文只整理仓库能直接核验的内容，不把星标、Fork 或宣传语当成质量证明。README 在"Shannon - AI Pentester by Keygraph"下的说明是：Shannon is an autonomous, AI pentester for web applications and APIs. It analyzes your source code, identifies attack paths, and executes real exploits to prove vulnerabilities before they reach production.。这给出的首先是项目边界，而不是已经完成的生产验证。

从 README 的"Prerequisites"和相关条目看，读者可以先判断它是否解决自己的具体问题：AI provider credentials: Anthropic, OpenAI, xAI, or AWS Bedrock. Claude models are recommended. For suggested model IDs per provider, plus gateways and custom base URLs, see AI providers.。如果你的目标与这段说明不一致，就不应仅凭项目热度采用它。这里保留原项目名、命令和组件名，方便回到一手来源核对。 README 还列出了另一条可核对的信息：Node.js 18+: required for the recommended npx workflow.。这类原文条目可以帮助读者设计试运行步骤，但不能代替自己的环境测试。

README 把工作方式分散写在"Shannon - AI Pentester by Keygraph"等段落中。可确认的线索包括：> [!TIP] > AI agents and LLMs: start with llms.txt for the README and docs combined into one file.。这篇整理没有把未写出的架构、性能或安全边界补成结论；真正的运行链仍应结合仓库目录、配置文件和版本标签检查。

第一次安装应从 README 给出的入口开始。当前可复核的命令是： README 没有给出可直接复制的安装命令。 如果仓库没有提供命令，本文不会替它编造安装步骤，而是建议先打开 README 的"Table of Contents"部分，确认系统依赖、默认端口和首次初始化动作。

日常使用的细节取决于项目实际文档。README 的"What is Shannon?"段落提到：Shannon is an autonomous AI pentester developed by Keygraph. It performs security testing of web applications and their underlying APIs by combining source-code analysis with live exploitation.。对于配置文件、环境变量、权限和数据目录，当前稿只记录来源明确的部分；未写明的默认值必须在测试环境中验证，并保留可回滚的配置副本。 同一部分还提到：Cyber safeguards cleared with your provider: Anthropic and OpenAI apply real-time safeguards to cyber-security workloads, which can interrupt a scan mid-run.。