How vishwaksen21/avelyn works
Avelyn is a cross-platform desktop text-enhancement app: users select text in another application, trigger a global shortcut, preview an AI rewrite, and choose whether to replace the selection. The runtime also supports multiple enhancement modes and providers, onboarding and permissions, local history/productivity features, and voice commands. The README documents the main capture-and-replace flow; sampled excerpts confirm startup, platform clipboard/focus handling, AI-provider responsibilities, and voice components. Some subsystem connections are omitted where their callers were not sampled.
Main entry points: main.py App coordinator · providers.py Provider adapters · platform_handler.py Platform input · ai_processor.py Enhancement processor
Components 23
Desktop workflow
- App coordinator
main.py - Global shortcuts
hotkeys.py - Platform input
platform_handler.py - Clipboard manager
clipboard_manager.py - Popup and tray UI
ui.py
AI enhancement
- Enhancement processor
ai_processor.py - Provider adapters
providers.py
Setup and state
- Settings
settings.py - Prompt history
knowledge_base.py - Usage tracking
productivity.py - Permission checks
permissions.py - Setup wizard
onboarding.py - Ollama setup
installer.py
Voice commands
- Voice command handler
voice_handler.py - Audio and transcription
voice_engine.py
Product website
- Product and help pages
website/src/app - Site components
website/src/components - FAQ content
website/src/data/faqDatabase.ts - Docs navigation
website/src/data/docsNavigation.ts
Other components
- User
- Editing app
- Gemini / OpenAI
- Ollama service
Connections 27
- User → Editing app: selects text
- User → Global shortcuts: presses shortcut
- Global shortcuts → App coordinator: dispatches shortcut
- App coordinator → Platform input: captures selection
- Platform input → Editing app: simulates copy
- App coordinator → Clipboard manager: reads selection
- Clipboard manager → Editing app: reads copied text
- App coordinator → Popup and tray UI: opens preview
- App coordinator → Enhancement processor: requests enhancement
- Enhancement processor → Provider adapters: selects backend
- Provider adapters → Gemini / OpenAI: sends request
- Provider adapters → Ollama service: sends request
- Provider adapters → Enhancement processor: streams response
- Popup and tray UI → App coordinator: confirms replacement
- App coordinator → Clipboard manager: sets enhanced text
- App coordinator → Platform input: pastes text
- Platform input → Editing app: restores focus and pastes
- App coordinator → Settings: loads configuration
- App coordinator → Permission checks: checks access
- App coordinator → Setup wizard: starts setup
- App coordinator → Ollama setup: starts Ollama
- App coordinator → Voice command handler: initializes voice
- Voice command handler → Audio and transcription: starts capture
- Voice command handler → Enhancement processor: requests voice action
- Product and help pages → Site components: renders with
- Site components → FAQ content: searches FAQs
- Site components → Docs navigation: lists documentation