README_EN.md

Table of Contents

1. Features
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Configuration Requirements
4. macOS Installation Guide
5. License
6. Star History

Features

• Voice Transcription: Integrates GLM ASR (Zhipu AI) for high-precision speech-to-text.

Built With

This section lists the major frameworks and libraries used to bootstrap this project.

• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

Follow these simple steps to get a local copy up and running.

Prerequisites

Ensure you have Node.js and npm installed.

• npm

  npm install npm@latest -g
  

Installation

1. Get a free API Key (See Configuration Requirements)
2. Clone the repo

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

3. Install NPM packages

   npm install
   

4. Run locally

   npm run dev
   

5. Enter your API Key in the Settings

(back to top)

Configuration Requirements

This application depends on the Zhipu AI (GLM) speech transcription service. You must configure an API Key before use.

1. Get API Key: Visit the Zhipu AI Open Platform (China or International) to register and obtain a Key.
2. Configure: Open the Voice Key settings page and enter your API Key.

macOS Installation Guide

Since the application is unsigned (we have not yet registered an Apple Developer account), you need to perform the following steps after installation:

1. Remove Security Restrictions
   If you receive a "File is damaged" message when opening the app, run the following command in the Terminal:

   xattr -cr /Applications/Voice\ Key.app
   

   

2. Grant Accessibility Permissions
   The application needs to listen for keystrokes and simulate input. Please go to System Settings > Privacy & Security > Accessibility and enable Voice Key.

License

This project is licensed under the Elastic License 2.0.

Star History