sherlock-project/sherlock:README 來源編輯指南
根據 README、倉庫資料與授權整理 sherlock-project/sherlock 的安裝與核驗路徑。
專案定位
sherlock-project/sherlock 的 README 將專案描述為「未提供一句話定位」。本文只整理倉庫可直接核對的內容,不把 star、Fork 或宣傳語當成品質證明。README 在「README」下寫到: • • 。這說明的是專案邊界,不是已完成的生產驗證。
適用場景
從 README 的「General usage」與相關條目,可以先判斷它是否處理你的實際問題:README 没有列出这一项具体能力。。若需求不同,不應只因專案熱度就採用。本文保留原始專案名、命令與元件名,方便回到一手來源核對。 README 另外列出一項可核對的資訊:README 没有列出这一项具体能力。。這類原文條目可用來設計試跑步驟,但不能取代實際環境測試。
運作方式
README 將運作方式分散在「Installation」等段落。可確認的線索包括:| Method | Notes | | - | - | | pipx install sherlock-project | pip or uv may be used in place of pipx | | docker run -it --rm sherlock/sherlock | | dnf install sherlock-project | |。本文不把未寫出的架構、效能或安全邊界補成結論;真正的執行鏈仍要配合目錄、設定檔與版本標籤檢查。
安裝與第一次執行
第一次安裝應從 README 指出的入口開始。目前可核對的命令是: $ sherlock --help usage: sherlock [-h] [--version] [--verbose] [--folderoutput FOLDEROUTPUT] [--output OUTPUT] [--csv] [--xlsx] [--site SITE_NAME] [--proxy PROXY_URL] [--dump-response] [--json JSON_FILE] [--timeout TIMEOUT] [--print-all] [--print-found] [--no-color] [--browse] [--local] [--nsfw] [--txt] [--ignore-exclusions] USERNAMES [USERNAMES ...] Sherlock: Find Usernames Across Social Networks (Version 0.16.0) positional arguments: USERNAMES On 如果倉庫沒有命令,本文不會自行編造步驟,而是建議先閱讀「General usage」,確認系統依賴、預設埠與首次初始化。
設定與日常使用
日常使用取決於專案文件。README 的「Installation」段落提到:Community-maintained packages are available for Debian (>= 13), Ubuntu (>= 22.10), Homebrew, Kali, and BlackArch. These packages are not directly supported or maintained by the Sherlock Project.。設定檔、環境變數、權限與資料目錄只在來源明確時才會記錄;沒有寫出的預設值,應在測試環境驗證並保留回滾副本。 同一部分也提到:README 没有列出这一项具体能力。。