Clerk Dictate

Türkçe versiyon için aşağı kaydırın / Scroll down for Turkish version

Clerk Dictate is an ultra-lightweight and smart Personal Voice Coding and Dictation Assistant designed for developers, running with zero UI clutter in the background. Powered by the Groq API (Whisper), it recognizes mixed Turkish-English software dictations with incredible speed and accuracy, learns the developer's custom dictionary, and types directly to your keyboard or copies to your clipboard.

---

How It Works?

The program runs completely hidden (no black screen) in the background. It has a small icon in the system tray at the bottom right.

• Start/Stop Dictation: You can speak by holding down (or pressing and releasing) the Alt+Q key on your keyboard.
  • (Tip: You can easily change this hotkey anytime by right-clicking the system tray icon and selecting "Change Hotkey".)
• When you finish speaking or pause, it automatically detects what you said and types everything directly into your currently active code editor (or any text box) as if you typed it on your keyboard.

Voice Commands and Smart Modes

Clerk Dictate doesn't just dictate; it has built-in smart modes activated by voice commands (Note: Voice commands are available in both English and Turkish):

1. Dictionary Mode ("Command dictionary" or "Kural sözlük")

   • If the AI misunderstands certain specific words (e.g., software terms), you can teach it permanent custom rules.
   • Usage: Press Alt+Q and say "Command dictionary, bitab replaced by github", and the program adds this to its permanent memory.
   • To exit the mode: Say "Command end" or "End command".

2. Clipboard Mode ("Command copy" or "Kural kopyala")

   • Sometimes, instead of typing directly to the screen, you may want to gather what you say and copy it all at once to your clipboard (Ctrl+V).
   • Usage: Say "Command copy" to enter this mode. Then, all sentences you say will accumulate in the background memory until you exit.
   • To exit the mode: As soon as you say "Command end", all accumulated text is copied to your clipboard. You can paste it anywhere with Ctrl+V.

---

Setup and API Key (Groq)

We use the free Groq API (Whisper Large V3 model) for lightning-fast performance.

1. Getting a Groq API Key:

   • Go to console.groq.com and create an account.
   • Navigate to the API Keys tab on the left menu, create a new key, and copy it.

2. Environment Setup:

   • Create a new file named .env in your project folder. (You can rename the provided .env.example file).
   • Paste the key you just copied into it in the following format and save:

     GROQ_API_KEY=gsk_your_long_copied_key_here

3. Required Libraries:

   • Install dependencies via your terminal in the project directory:

     pip install -r requirements.txt

   • (Note: Due to OS-level hardware restrictions of the keyboard module, you may need to run the script with sudo privileges when using it on Linux. There is no such issue on Windows and macOS.)

---

Running Automatically on Windows Startup

To have Clerk Dictate run silently in the background every time your computer starts (without even showing a black console screen), follow these easy steps:

1. Press Windows + R on your keyboard, type shell:startup in the Run window, and press Enter.
2. Right-click inside the opened empty folder and select New -> Shortcut.
3. Paste the following command into the shortcut box (editing according to your folder paths): (Note: Using pythonw.exe instead of python.exe prevents the black terminal window)

   C:\Projeleriniz\clerk-dictate\venv\Scripts\pythonw.exe C:\Projeleriniz\clerk-dictate\main.py
   

4. Click Next, give the shortcut a name (e.g., Clerk Dictate), and click Finish.
5. Very Important Step: Right-click this newly created shortcut and go to Properties. Remove the venv\Scripts part from the end of the path in the "Start in" field. Only the main project folder path should remain in that box (e.g., C:\Projeleriniz\clerk-dictate).
6. Click Apply and OK.

Your assistant is now ready for duty every time Windows starts!

---

---

Türkçe Versiyon

Clerk Dictate, geliştiriciler için tasarlanmış, arka planda sıfır arayüz karmaşasıyla çalışan ultra hafif ve akıllı bir Kişisel Sesli Kodlama ve Dikte Asistanıdır. Groq API (Whisper) altyapısını kullanarak Türkçe-İngilizce karışık yazılım diktelerini inanılmaz bir hız ve doğrulukla algılar, geliştiricinin özel sözlüğünü öğrenir ve sesi doğrudan klavyeye veya panoya aktarır.

---

Nasıl Çalışır?

Program arka planda tamamen gizli (siyah ekransız) çalışır. Sağ alt köşedeki sistem tepsisinde (Tray) küçük bir ikonu bulunur.

• Dikte Başlat/Durdur: Klavyenizden Alt+Q tuşuna basılı tutarak (veya bas-çek yaparak) konuşabilirsiniz.
  • (İpucu: Kısayol tuşunu dilediğiniz zaman sağ alt köşedeki sistem tepsisi (tray) ikonuna sağ tıklayıp "Kısayolu Değiştir" diyerek anında değiştirebilirsiniz.)
• Konuşmanız bittiğinde veya siz sustuğunuzda otomatik olarak ne söylediğinizi algılar ve söylediğiniz her şeyi klavyeden yazılmış gibi o an açık olan kod editörünüze (veya herhangi bir metin kutusuna) yazar.

Sesli Komutlar ve Akıllı Modlar

Clerk Dictate sadece dikte etmekle kalmaz, kendi içinde sesli komutlarla çalışan modlara sahiptir:

1. Sözlük Modu ("Kural sözlük")

   • Yapay zeka bazı özel kelimeleri (örneğin yazılım terimlerini) yanlış anlıyorsa, ona kalıcı özel kurallar öğretebilirsiniz.
   • Kullanımı: Alt+Q'ya basıp "Kural sözlük, memori yerine memory" derseniz, program bunu kalıcı hafızasına ekler.
   • Moddan çıkmak için: "Kural bitti" veya "Kural sonu" diyebilirsiniz.

2. Kopyalama / Pano Modu ("Kural kopyala")

   • Bazen ekrana doğrudan yazdırmak yerine, söylediklerinizi toparlayıp tek seferde panoya (Clipboard - Ctrl+V) almak isteyebilirsiniz.
   • Kullanımı: "Kural kopyala" diyerek bu moda girersiniz. Ardından söylediğiniz tüm cümleler siz çıkana kadar arka plandaki hafızada birikir.
   • Moddan çıkmak için: "Kural bitti" veya "Kural sonu" dediğiniz an, biriktirilen tüm metin panonuza kopyalanır. İstediğiniz yere sadece Ctrl+V ile yapıştırabilirsiniz.

---

Kurulum ve API Anahtarı (Groq)

Uygulamanın şimşek hızında çalışabilmesi için ücretsiz Groq API'sini (Whisper Large V3 modeli) kullanıyoruz.

1. Groq API Key Alma:

   • console.groq.com adresine gidin ve hesap oluşturun.
   • Sol menüden API Keys sekmesine geçip yeni bir key oluşturun ve kopyalayın.

2. Ortam (Environment) Ayarı:

   • Proje klasörünüzün içine .env adında (başında nokta olan) yeni bir dosya oluşturun. (Dilerseniz örnek olması için konulan .env.example dosyasının adını değiştirebilirsiniz).
   • İçine az önce kopyaladığınız anahtarı şu formatta yapıştırıp kaydedin:

     GROQ_API_KEY=gsk_sizin_kopyaladiginiz_uzun_sifre

3. Gerekli Kütüphaneler:

   • Bilgisayarınızın terminalinde proje dizinindeyken bağımlılıkları kurun:

     pip install -r requirements.txt

   • (Not: keyboard modülünün işletim sistemi seviyesindeki donanım kısıtlamaları sebebiyle, projeyi Linux işletim sistemlerinde kullanırken sudo yetkisiyle çalıştırmanız gerekebilir. Windows ve Mac'te böyle bir durum yoktur.)

---

Windows'ta Başlangıçta Otomatik Çalıştırma

Clerk Dictate'in bilgisayarınız her açıldığında arka planda sessizce (siyah konsol ekranı bile çıkmadan) çalışması için şu kolay adımları izleyebilirsiniz:

1. Klavyenizden Windows + R tuşlarına basın, Çalıştır penceresine shell:startup yazıp Enter'a basın.
2. Açılan boş klasörün içine sağ tıklayıp Yeni -> Kısayol deyin.
3. Kısayol kutusuna (kendi klasör yollarınıza göre düzenleyerek) şu komutu yapıştırın: (Dikkat: python.exe yerine pythonw.exe kullanmak siyah terminal penceresini engeller)

   C:\Projeleriniz\clerk-dictate\venv\Scripts\pythonw.exe C:\Projeleriniz\clerk-dictate\main.py
   

4. İleri deyip kısayola bir isim (örn: Clerk Dictate) verin ve Son'a tıklayın.
5. Çok Önemli Adım: Oluşan bu kısayola sağ tıklayıp Özellikler'e girin. Başlama yeri (Start in) kısmındaki yolun sonundan venv\Scripts bölümünü silin. O kutuda sadece projenin ana klasör yolu kalmalı (Örn: C:\Projeleriniz\clerk-dictate).
6. Uygula ve Tamam deyin.

Artık asistanınız her Windows açılışında göreve hazırdır!