QuintinShaw/openasr:README 來源編輯指南
根據 README、倉庫資料與授權整理 QuintinShaw/openasr 的安裝與核驗路徑。
專案定位
QuintinShaw/openasr 的 README 將專案描述為「Local-first speech-to-text: no cloud, no telemetry, fail-closed by design. One CLI, seven model families, signed model catalog, OpenAI-compatible local API.」。本文只整理倉庫可直接核對的內容,不把 star、Fork 或宣傳語當成品質證明。README 在「OpenASR」下寫到:Turn speech into text, entirely on your device.。這說明的是專案邊界,不是已完成的生產驗證。
適用場景
從 README 的「What it does」與相關條目,可以先判斷它是否處理你的實際問題:Live captions , real-time transcription from your microphone with streaming partial results。若需求不同,不應只因專案熱度就採用。本文保留原始專案名、命令與元件名,方便回到一手來源核對。 README 另外列出一項可核對的資訊:Transcribe audio files , single files or entire folders, output as plain text, SRT/VTT subtitles, or JSON with word-level timestamps。這類原文條目可用來設計試跑步驟,但不能取代實際環境測試。
運作方式
README 將運作方式分散在「OpenASR」等段落。可確認的線索包括:> This repository is the Apache-2.0 open core behind the desktop app: a Rust CLI, a local OpenAI-compatible HTTP API, and the ggml inference engine. The desktop app wraps the same engine in a native GUI , no hidden network calls.。本文不把未寫出的架構、效能或安全邊界補成結論;真正的執行鏈仍要配合目錄、設定檔與版本標籤檢查。
安裝與第一次執行
第一次安裝應從 README 指出的入口開始。目前可核對的命令是: # Option A: Homebrew (macOS / Linux) brew install quintinshaw/tap/openasr # Option B: one-line installer (macOS / Linux) curl -fsSL https://dl.openasr.org/install.sh | sh # Option C: grab a prebuilt binary from Releases # https://github.com/QuintinShaw/openasr/releases # Transcribe a file (first run offers to download a model , you confirm first) openasr transcribe recording.wav # Live mic captions openasr live # SRT subtitles with speaker labels openasr transcribe meeting.wav -f srt --diar 如果倉庫沒有命令,本文不會自行編造步驟,而是建議先閱讀「What it does」,確認系統依賴、預設埠與首次初始化。
設定與日常使用
日常使用取決於專案文件。README 的「Why OpenASR」段落提到:Private. In the default local mode, audio stays on your machine. Remote compute is available only when you explicitly pair and enable it; see SECURITY.md. No telemetry, no silent uploads, and no silent network fallback.。設定檔、環境變數、權限與資料目錄只在來源明確時才會記錄;沒有寫出的預設值,應在測試環境驗證並保留回滾副本。 同一部分也提到:System audio capture , caption meetings, lectures, and podcasts by recording what your computer plays。