thClaws/thClaws:README 來源編輯指南
根據 README、倉庫資料與授權整理 thClaws/thClaws 的安裝與核驗路徑。
專案定位
thClaws/thClaws 的 README 將專案描述為「Open-source AI agent harness in native Rust , GUI, CLI, headless, and webapp from one binary. Multi-provider, MCP, skills, plugins, agent teams.」。本文只整理倉庫可直接核對的內容,不把 star、Fork 或宣傳語當成品質證明。README 在「thClaws 🦞」下寫到:The open-source agent harness, in your terminal and on your desktop.。這說明的是專案邊界,不是已完成的生產驗證。
適用場景
從 README 的「Four surfaces, one engine」與相關條目,可以先判斷它是否處理你的實際問題:CLI REPL (thclaws --cli) , interactive terminal prompt for SSH, headless servers, or zero-GUI workflows.。若需求不同,不應只因專案熱度就採用。本文保留原始專案名、命令與元件名,方便回到一手來源核對。 README 另外列出一項可核對的資訊:Desktop GUI (thclaws) , native window with Terminal, Chat, Files, and optional Team tabs.。這類原文條目可用來設計試跑步驟,但不能取代實際環境測試。
運作方式
README 將運作方式分散在「See it work」等段落。可確認的線索包括:Three tabs, one binary , captured from a live thClaws session looking at its own source.。本文不把未寫出的架構、效能或安全邊界補成結論;真正的執行鏈仍要配合目錄、設定檔與版本標籤檢查。
安裝與第一次執行
第一次安裝應從 README 指出的入口開始。目前可核對的命令是: git clone https://github.com/thClaws/thClaws.git cd thClaws # One-shot: build frontend, then cargo build --features gui ./scripts/build.sh # macOS / Linux ./scripts/build.ps1 # Windows PowerShell # Verification suite (cargo fmt --check, clippy, tsc, cargo test) ./scripts/build.sh --check # Run cargo run --features gui # GUI cargo run -- --cli # CLI REPL cargo run -- -p "explain crates/core" # one-shot 如果倉庫沒有命令,本文不會自行編造步驟,而是建議先閱讀「See it work」,確認系統依賴、預設埠與首次初始化。
設定與日常使用
日常使用取決於專案文件。README 的「See it work」段落提到:Files (codemirror + tiptap) · Terminal (REPL · slash commands · ANSI tool output) · Chat (markdown render · tool indicators)。設定檔、環境變數、權限與資料目錄只在來源明確時才會記錄;沒有寫出的預設值,應在測試環境驗證並保留回滾副本。 同一部分也提到:Non-interactive mode (thclaws -p "prompt") , single turn, exits. Pipe-friendly for scripts and CI. -v for token usage on stderr.。