English

Voice Key

一款开源的桌面端语音输入产品

查看演示 · 报告 Bug · 请求功能

目录

1. 主要功能
   • 技术栈
2. 上手指南
   • 环境要求
   • 安装步骤
3. 测试
4. 配置要求
5. macOS 安装指南
6. 开源协议
7. Star History

主要功能

• 语音转写: 集成 GLM ASR (智谱AI) 实现高精度的语音转文字。

技术栈

本项目使用了以下主要框架和库：

• 
• 
• 
• 
• 
• 
• 

(back to top)

上手指南

按照以下步骤在本地搭建并运行项目。

环境要求

开发前请确保已安装 Node.js 和 npm。

• npm

  npm install npm@latest -g

安装步骤

1. 获取免费 API Key (详见 配置要求)
2. 克隆仓库

   git clone https://github.com/BuildWithAIs/voicekey.git

3. 安装依赖包

   npm install

4. 运行开发环境

   npm run dev

5. 在应用设置中填入你的 API Key

(back to top)

测试

测试集成方案与配置示例详见 temp-docs/testing/integration-guide.md，核心配置文件为 vitest.config.ts 与 playwright.config.ts。渲染/主进程测试设置位于 test/， E2E 用例位于 e2e/。 Vitest 默认忽略 website/ 目录（官网项目不参与测试与覆盖率）。

配置要求

本应用依赖 智谱 AI (GLM) 的语音转写服务。使用前请务必配置 API Key。

1. 获取 API Key: 访问智谱 AI 开放平台中国版 或者 国际版 注册并获取 Key。
2. 配置: 打开 Voice Key 设置页面，填入你的 API Key。

macOS 安装指南

由于应用未签名（我们还没有注册 Apple 开发者账户），安装后需执行以下步骤：

1. 解除安全限制
   若打开应用提示“文件已损坏”，请在终端运行以下命令：

   xattr -cr /Applications/Voice\ Key.app

   

2. 授予辅助功能权限
   应用需要监听按键与模拟输入。请前往 系统设置 > 隐私与安全性 > 辅助功能 开启 Voice Key。

开源协议

本项目采用 Elastic License 2.0 开源协议。

Star History

(back to top)