🚀 One-Click Installation

Install WinterMelon Scribe with a single command. The program will automatically run in the background and start with your Mac.

Install in One Command ⭐

# 1. Clone or download the project
git clone https://github.com/ParseDark/wintermelon_scribe.git
cd wintermelon_scribe
 
# 2. One-click install (automatically configures everything)
./install.sh

After Installation

• 🔋 Auto-start at boot
• 🤫 Runs silently in background
• 🚫 No terminal window needed
• ⌨️ Hotkey Ctrl + / ready to use
• 🎙️ Process name shows as "WinterMelon Scribe"

First Time Use

1. Grant_permissions

After installation, the system will prompt you to grant permissions:

1. System Preferences → Security & Privacy → Privacy
2. Select Accessibility → Add Terminal or Python application
3. Select Screen Recording → Add Terminal or Python application

⚠️ Restart the program after setting permissions

2. Configure API KeysEdit the .env file:

# Transcription service (choose one)
SILICONFLOW_API_KEY=your-api-key-here
# OR
GROQ_API_KEY=your-groq-api-key-here
TRANSCRIPTION_PROVIDER=groq

3. Get API Keys

SiliconFlow (Recommended)

• Register: cloud.siliconflow.cn/i/VQcfhhQS (opens in a new tab) ↗
• Get key: API Keys (opens in a new tab) ↗

Groq Alternative

• Register: groq.com (opens in a new tab)
• Get API key from dashboard

Common Operations

Check Running Status

./status.sh

Uninstall the Program

./uninstall.sh

Update Configuration

After modifying .env file:

./uninstall.sh && ./install.sh

Usage

1. Press Ctrl + / to start recording
2. Speak naturally
3. Release key to automatically process and paste

That's it! WinterMelon Scribe is now configured and ready to use.