Configuration

WinterMelon Scribe uses a .env file for configuration. Copy .env.example to .env and modify as needed:

cp .env.example .env

Transcription Service Configuration

Choose ONE transcription provider:

SiliconFlow (Recommended)

SILICONFLOW_API_KEY=your-api-key-here
# Optional: specify model
SILICONFLOW_MODEL=FunAudioLLM/SenseVoiceSmall

Groq Alternative

GROQ_API_KEY=your-groq-api-key-here
TRANSCRIPTION_PROVIDER=groq
# Optional: specify model
GROQ_MODEL=whisper-large-v3-turbo

LLM Enhancement Settings

Enable and configure AI text processing:

# Enable LLM processing
LLM_ENABLED=true

# OpenAI configuration
OPENAI_API_KEY=your-openai-api-key-here
OPENAI_MODEL=gpt-3.5-turbo

# Processing parameters
LLM_TEMPERATURE=0.7
LLM_MAX_TOKENS=1000

Custom Prompt Example

LLM_CUSTOM_PROMPT=Please optimize the expression of the following text:

Notification Settings

Configure system notifications:

# Enable notifications
NOTIFICATION_ENABLED=true

# Enable notification sounds
NOTIFICATION_SOUND_ENABLED=true

Complete Example

# .env file
# SiliconFlow (recommended)
SILICONFLOW_API_KEY=your-api-key-here

# Groq alternative
# GROQ_API_KEY=your-groq-api-key-here
# TRANSCRIPTION_PROVIDER=groq

# LLM enhancement
LLM_ENABLED=true
OPENAI_API_KEY=your-openai-api-key-here
OPENAI_MODEL=gpt-3.5-turbo

# Custom processing
LLM_CUSTOM_PROMPT=Please optimize the following text:

# Notifications
NOTIFICATION_ENABLED=true
NOTIFICATION_SOUND_ENABLED=true

# Debug mode (development only)
# DEBUG=true

API Key Management

SiliconFlow

Register: 注册硅基流动 (opens in a new tab) ↗
Dashboard: cloud.siliconflow.cn (opens in a new tab)
API Keys: 管理 API 密钥 (opens in a new tab) ↗

Groq

Register: groq.com (opens in a new tab)
Dashboard: Console → API Keys

OpenAI

Register: platform.openai.com (opens in a new tab)
Dashboard: API keys section

Applying Changes

After modifying .env:

For Background Service (User Install)

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

For Direct Run (Developer Mode)

# Stop the current process
# Then restart
source .venv/bin/activate
python main.py

Environment Variables Reference

Variable	Required	Description
`SILICONFLOW_API_KEY`	Yes (if using SiliconFlow)	API key for SiliconFlow
`GROQ_API_KEY`	Yes (if using Groq)	API key for Groq
`TRANSCRIPTION_PROVIDER`	Optional	`siliconflow` (default) or `groq`
`OPENAI_API_KEY`	Yes (if using LLM)	API key for OpenAI
`LLM_ENABLED`	Optional	`true` or `false` (default)
`OPENAI_MODEL`	Optional	`gpt-3.5-turbo`, `gpt-4`, etc.
`LLM_TEMPERATURE`	Optional	0.0-1.0 (default: 0.7)
`LLM_MAX_TOKENS`	Optional	Maximum output tokens
`NOTIFICATION_ENABLED`	Optional	`true` (default) or `false`
`DEBUG`	Optional	`true` or `false` (development only)

👨‍💻 Developer Installation 🎮 Usage