QuintinShaw/openasr: README-based editorial guide
A guide grounded in the README, repository metadata, and license for installing and checking QuintinShaw/openasr.
Project scope
QuintinShaw/openasr describes itself in the README as "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.". This article keeps to facts that can be checked in the repository. Stars, forks, and promotional badges are signals of attention, not proof of quality. Under "OpenASR", the README says: Turn speech into text, entirely on your device.. That establishes the project's stated boundary, not a production test.
Suitable use cases
The README's "What it does" section gives a useful starting point for deciding whether the project fits: Live captions , real-time transcription from your microphone with streaming partial results. If that problem is not yours, popularity is a poor reason to adopt it. Project names, commands, and component names are kept as written so a reader can return to the primary source without guessing at terminology. Another checkable README item is: Transcribe audio files , single files or entire folders, output as plain text, SRT/VTT subtitles, or JSON with word-level timestamps. It can shape a first test, but it does not replace testing in the intended environment.
How it works
The operating model is spread across sections such as "OpenASR". The source evidence includes: > 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.. This article does not turn missing architecture, performance, or security details into claims. A real deployment still needs a look at the repository layout, configuration files, and release history.
Installation and first run
Start installation from the README's documented entry point. A command that can be checked in the source is: # 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 When the README contains no runnable command, this article does not invent one. Open its "What it does" section and confirm system dependencies, default ports, and first-run initialization before using a public server.