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.」。本文只整理倉庫可直接核對的內容，不把 star、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 没有给出可直接复制的安装命令。 如果倉庫沒有命令，本文不會自行編造步驟，而是建議先閱讀「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.。