跳转到内容
OpenASR

CLI 快速上手

OpenASR 的 Rust CLI、本地 HTTP API 和模型目录均在 GitHub 开源仓库中维护，采用 Apache-2.0 许可证。

安装 CLI

Section titled “安装 CLI”

下载预编译版本

Section titled “下载预编译版本”

这是最快的安装方式。GitHub Releases 提供 macOS（arm64、x86_64）、Linux（x86_64、arm64）和 Windows（x86_64、arm64）的预编译压缩包，此外 Linux 和 Windows 还各自提供 CUDA/ROCm/Vulkan 后端变体，Linux 另有 musl 变体。下载后先用同一版本附带的 SHA256SUMS 校验文件，再解压运行：

macOS / Linux：

bash
tar -xzf openasr-*-macos-arm64.tar.gz    # 或 -macos-x86_64 / -linux-x86_64 / -linux-arm64
./openasr --help

Windows：

powershell
Expand-Archive openasr-*-windows-x86_64.zip
.\openasr.exe --help

确认可以正常运行后，将 openasr 放到系统的 PATH 中，即可在任意目录使用。

从源码编译

Section titled “从源码编译”

ggml 后端以 Git 子模块提供，因此需要递归克隆仓库。编译环境需要 cmake、C/C++ 工具链，以及 rust-toolchain.toml 锁定的 Rust 1.95.0；Linux 还需要安装 libasound2-dev。

bash
git clone --recurse-submodules https://github.com/QuintinShaw/openasr.git
cd openasr
cargo build --release -p openasr-cli

生成的可执行文件位于 target/release/openasr。

如果你更习惯图形界面，可以查看桌面应用指南。桌面应用是一个独立的闭源产品，与开源 CLI 分开维护。

转写第一个音频文件

Section titled “转写第一个音频文件”
bash
openasr transcribe audio.wav

OpenASR 默认使用 native 后端，在本机运行 ggml 支持的 .oasr 模型包。首次使用时，如果默认模型尚未安装，CLI 会先显示模型、量化精度、文件大小、下载地址和许可证，得到确认后才会下载；安装完成后的转写可完全离线运行。

指定模型、字幕格式和输出文件：

bash
openasr t audio.wav --model whisper-small --format srt --output audio.srt

t 是 transcribe 的简写。你也可以一次处理整个目录，或同时输出多种格式：

bash
openasr transcribe ./recordings --output ./transcripts
openasr transcribe audio.wav --format srt --format vtt --format json

如果运行过程中不允许任何网络访问，请加上 --offline。模型未安装时，命令会直接报错，不会尝试下载：

bash
openasr transcribe audio.wav --offline

查找和管理模型

Section titled “查找和管理模型”
bash
openasr search                  # 浏览模型目录
openasr pull whisper-small      # 下载并安装模型包
openasr list                    # 查看已安装的模型包
openasr show whisper-small      # 查看目录信息或本地模型包详情
openasr rm whisper-small        # 删除已安装的模型包

更多可用模型可在模型页面查看。

检查本地模型包

Section titled “检查本地模型包”

下面两条命令只读取本地文件，不会下载内容，也不会运行推理：

bash
openasr verify /path/to/model.oasr
openasr show /path/to/model.oasr

需要绕过已安装模型的解析流程、直接使用某个本地模型包时，可传入 --model-pack：

bash
openasr transcribe audio.wav --model-pack /path/to/model.oasr

启动本地 API

Section titled “启动本地 API”
bash
openasr serve

服务启动后，可通过兼容 OpenAI 格式的转写接口调用：

bash
curl -s http://127.0.0.1:8080/v1/audio/transcriptions \
  -F [email protected] \
  -F model=whisper-small \
  -F response_format=json

转写请求只会使用已经安装或通过 --model-pack 明确指定的本地模型，不会在请求过程中自动下载模型。

认证、TLS 和远程访问配置见本地服务 API。

排查环境问题

Section titled “排查环境问题”
bash
openasr doctor

完整命令说明见 CLI 参考。当前版本实际支持的参数以 openasr --help 和 openasr <command> --help 为准。