cmd-kural 0.1.2__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- cmd_kural-0.1.2.dist-info/METADATA +510 -0
- cmd_kural-0.1.2.dist-info/RECORD +72 -0
- cmd_kural-0.1.2.dist-info/WHEEL +4 -0
- cmd_kural-0.1.2.dist-info/entry_points.txt +2 -0
- cmd_kural-0.1.2.dist-info/licenses/LICENSE +34 -0
- kural/__init__.py +3 -0
- kural/__main__.py +345 -0
- kural/config/__init__.py +8 -0
- kural/config/app_rules.defaults.yaml +68 -0
- kural/config/commands.defaults.yaml +65 -0
- kural/config/config.defaults.yaml +212 -0
- kural/config/config_manager.py +568 -0
- kural/config/configcheck.py +218 -0
- kural/config/defaults_merge.py +269 -0
- kural/control/__init__.py +79 -0
- kural/control/app_index.py +270 -0
- kural/control/app_rules.py +149 -0
- kural/control/autostart.py +112 -0
- kural/control/chords.py +90 -0
- kural/control/executor.py +365 -0
- kural/control/guardrails.py +154 -0
- kural/control/llm_fallback.py +137 -0
- kural/control/media.py +247 -0
- kural/control/mouse.py +185 -0
- kural/control/parser.py +448 -0
- kural/control/planner.py +250 -0
- kural/control/windows.py +672 -0
- kural/doctor.py +344 -0
- kural/engine/__init__.py +6 -0
- kural/engine/adaptive.py +231 -0
- kural/engine/audio_ducking.py +104 -0
- kural/engine/audio_feedback.py +130 -0
- kural/engine/audio_gain.py +40 -0
- kural/engine/audio_recorder.py +547 -0
- kural/engine/bundle_logs.py +175 -0
- kural/engine/cues.py +80 -0
- kural/engine/dictation_cleanup.py +358 -0
- kural/engine/dictation_languages.py +96 -0
- kural/engine/dictionary.py +104 -0
- kural/engine/file_transcriber.py +293 -0
- kural/engine/flow_formatting.py +118 -0
- kural/engine/hardware_detection.py +237 -0
- kural/engine/history.py +188 -0
- kural/engine/instance_manager.py +154 -0
- kural/engine/log_setup.py +83 -0
- kural/engine/model_registry.py +184 -0
- kural/engine/model_transfer.py +233 -0
- kural/engine/noise_suppression.py +51 -0
- kural/engine/notes.py +80 -0
- kural/engine/recovery.py +196 -0
- kural/engine/server.py +322 -0
- kural/engine/snippets.py +96 -0
- kural/engine/stop_phrase.py +74 -0
- kural/engine/streaming.py +106 -0
- kural/engine/streaming_delivery.py +127 -0
- kural/engine/streaming_manager.py +127 -0
- kural/engine/streaming_recognizer.py +163 -0
- kural/engine/transforms.py +288 -0
- kural/engine/utils.py +296 -0
- kural/engine/voice_activity_detection.py +336 -0
- kural/engine/wake_word.py +83 -0
- kural/engine/whisper_engine.py +412 -0
- kural/runtime.py +814 -0
- kural/selftest.py +198 -0
- kural/ui/__init__.py +9 -0
- kural/ui/cheat_sheet.py +245 -0
- kural/ui/fallback_window.py +240 -0
- kural/ui/history_window.py +277 -0
- kural/ui/overlay.py +315 -0
- kural/ui/settings_window.py +500 -0
- kural/ui/terminal_title.py +152 -0
- kural/ui/tray.py +161 -0
kural/__main__.py
ADDED
|
@@ -0,0 +1,345 @@
|
|
|
1
|
+
"""Entry point for `python -m kural`."""
|
|
2
|
+
|
|
3
|
+
import argparse
|
|
4
|
+
import sys
|
|
5
|
+
|
|
6
|
+
from kural.engine.utils import get_version
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
def main() -> None:
|
|
10
|
+
"""Start the Kural application or run CLI commands."""
|
|
11
|
+
parser = argparse.ArgumentParser(
|
|
12
|
+
prog="kural",
|
|
13
|
+
description="Local-first voice typing and voice control for Windows. English and Tamil.",
|
|
14
|
+
)
|
|
15
|
+
parser.add_argument(
|
|
16
|
+
"--doctor",
|
|
17
|
+
action="store_true",
|
|
18
|
+
help="Run environment, hardware, GPU, audio, and configuration diagnostics.",
|
|
19
|
+
)
|
|
20
|
+
parser.add_argument(
|
|
21
|
+
"--selftest",
|
|
22
|
+
action="store_true",
|
|
23
|
+
help="Run live end-to-end operational self-test diagnostics (mic, model, inference, clipboard).",
|
|
24
|
+
)
|
|
25
|
+
parser.add_argument(
|
|
26
|
+
"--bundle-logs",
|
|
27
|
+
nargs="?",
|
|
28
|
+
const="",
|
|
29
|
+
metavar="ZIP_PATH",
|
|
30
|
+
help="Create a redacted diagnostic zip archive for bug reports.",
|
|
31
|
+
)
|
|
32
|
+
parser.add_argument(
|
|
33
|
+
"--transcribe",
|
|
34
|
+
type=str,
|
|
35
|
+
metavar="AUDIO_FILE",
|
|
36
|
+
help="Transcribe an audio file offline (WAV, MP3, M4A, FLAC) and print or save the transcript.",
|
|
37
|
+
)
|
|
38
|
+
parser.add_argument(
|
|
39
|
+
"--format",
|
|
40
|
+
choices=["text", "srt", "json"],
|
|
41
|
+
default="text",
|
|
42
|
+
help="Output format for file transcription (default: text).",
|
|
43
|
+
)
|
|
44
|
+
parser.add_argument(
|
|
45
|
+
"--output",
|
|
46
|
+
"-o",
|
|
47
|
+
type=str,
|
|
48
|
+
metavar="OUTPUT_FILE",
|
|
49
|
+
help="Destination path to write transcript instead of printing to stdout.",
|
|
50
|
+
)
|
|
51
|
+
parser.add_argument(
|
|
52
|
+
"--settings",
|
|
53
|
+
action="store_true",
|
|
54
|
+
help="Open the graphical settings configuration window.",
|
|
55
|
+
)
|
|
56
|
+
parser.add_argument(
|
|
57
|
+
"--dict-list",
|
|
58
|
+
action="store_true",
|
|
59
|
+
help="List all custom dictionary hotwords.",
|
|
60
|
+
)
|
|
61
|
+
parser.add_argument(
|
|
62
|
+
"--dict-add",
|
|
63
|
+
type=str,
|
|
64
|
+
metavar="WORD",
|
|
65
|
+
help="Add a custom word or Tamil proper noun to dictionary hotwords.",
|
|
66
|
+
)
|
|
67
|
+
parser.add_argument(
|
|
68
|
+
"--dict-remove",
|
|
69
|
+
type=str,
|
|
70
|
+
metavar="WORD",
|
|
71
|
+
help="Remove a custom word from dictionary hotwords.",
|
|
72
|
+
)
|
|
73
|
+
parser.add_argument(
|
|
74
|
+
"--history",
|
|
75
|
+
nargs="?",
|
|
76
|
+
const="",
|
|
77
|
+
metavar="QUERY",
|
|
78
|
+
help="Search dictation history (BM25 ranking), or show latest if no query given.",
|
|
79
|
+
)
|
|
80
|
+
parser.add_argument(
|
|
81
|
+
"--history-gui",
|
|
82
|
+
action="store_true",
|
|
83
|
+
help="Open the graphical history browser window.",
|
|
84
|
+
)
|
|
85
|
+
parser.add_argument(
|
|
86
|
+
"--cheat-sheet",
|
|
87
|
+
action="store_true",
|
|
88
|
+
help="Open the hotkeys and voice commands cheat sheet reference card.",
|
|
89
|
+
)
|
|
90
|
+
parser.add_argument(
|
|
91
|
+
"--stats",
|
|
92
|
+
action="store_true",
|
|
93
|
+
help="Display productivity statistics (words, speaking WPM, time saved, streak).",
|
|
94
|
+
)
|
|
95
|
+
parser.add_argument(
|
|
96
|
+
"--autostart-status",
|
|
97
|
+
action="store_true",
|
|
98
|
+
help="Check whether Kural is configured to launch on Windows startup.",
|
|
99
|
+
)
|
|
100
|
+
parser.add_argument(
|
|
101
|
+
"--enable-autostart",
|
|
102
|
+
action="store_true",
|
|
103
|
+
help="Configure Kural to launch automatically on Windows login (windowless).",
|
|
104
|
+
)
|
|
105
|
+
parser.add_argument(
|
|
106
|
+
"--disable-autostart",
|
|
107
|
+
action="store_true",
|
|
108
|
+
help="Remove Kural from Windows startup.",
|
|
109
|
+
)
|
|
110
|
+
parser.add_argument(
|
|
111
|
+
"--serve",
|
|
112
|
+
action="store_true",
|
|
113
|
+
help="Run local OpenAI-compatible Whisper API server.",
|
|
114
|
+
)
|
|
115
|
+
parser.add_argument(
|
|
116
|
+
"--host",
|
|
117
|
+
type=str,
|
|
118
|
+
default="127.0.0.1",
|
|
119
|
+
help="Host address to bind local server to (default: 127.0.0.1).",
|
|
120
|
+
)
|
|
121
|
+
parser.add_argument(
|
|
122
|
+
"--port",
|
|
123
|
+
type=int,
|
|
124
|
+
default=7777,
|
|
125
|
+
help="Port to bind local server to (default: 7777).",
|
|
126
|
+
)
|
|
127
|
+
parser.add_argument(
|
|
128
|
+
"--config-check",
|
|
129
|
+
action="store_true",
|
|
130
|
+
help="Audit configuration integrity and check for invalid or out-of-bounds keys.",
|
|
131
|
+
)
|
|
132
|
+
parser.add_argument(
|
|
133
|
+
"--version",
|
|
134
|
+
action="version",
|
|
135
|
+
version=f"%(prog)s {get_version()}",
|
|
136
|
+
)
|
|
137
|
+
|
|
138
|
+
parser.add_argument("--packaging-smoke", action="store_true", help=argparse.SUPPRESS)
|
|
139
|
+
args = parser.parse_args()
|
|
140
|
+
|
|
141
|
+
if args.packaging_smoke:
|
|
142
|
+
from importlib import import_module
|
|
143
|
+
from importlib.resources import files
|
|
144
|
+
|
|
145
|
+
from kural.config import ConfigManager
|
|
146
|
+
|
|
147
|
+
for module in (
|
|
148
|
+
"faster_whisper",
|
|
149
|
+
"ctranslate2",
|
|
150
|
+
"sounddevice",
|
|
151
|
+
"soxr",
|
|
152
|
+
"global_hotkeys",
|
|
153
|
+
"pyperclip",
|
|
154
|
+
"pystray",
|
|
155
|
+
"PIL.Image",
|
|
156
|
+
"tkinter",
|
|
157
|
+
"kural.runtime",
|
|
158
|
+
):
|
|
159
|
+
import_module(module)
|
|
160
|
+
for asset in ("config.defaults.yaml", "commands.defaults.yaml", "app_rules.defaults.yaml"):
|
|
161
|
+
assert files("kural.config").joinpath(asset).is_file(), asset
|
|
162
|
+
assert ConfigManager(use_user_settings=False, quiet=True).config
|
|
163
|
+
print("Offline desktop packaging smoke passed")
|
|
164
|
+
return
|
|
165
|
+
|
|
166
|
+
if args.doctor:
|
|
167
|
+
from kural.doctor import run_doctor
|
|
168
|
+
|
|
169
|
+
sys.exit(run_doctor())
|
|
170
|
+
|
|
171
|
+
if args.selftest:
|
|
172
|
+
from kural.selftest import run_selftest
|
|
173
|
+
|
|
174
|
+
sys.exit(run_selftest())
|
|
175
|
+
|
|
176
|
+
if args.bundle_logs is not None:
|
|
177
|
+
from kural.engine.bundle_logs import bundle_logs
|
|
178
|
+
|
|
179
|
+
out = args.bundle_logs if args.bundle_logs.strip() else None
|
|
180
|
+
sys.exit(bundle_logs(out))
|
|
181
|
+
|
|
182
|
+
if args.transcribe:
|
|
183
|
+
from kural.engine.file_transcriber import transcribe_file
|
|
184
|
+
|
|
185
|
+
try:
|
|
186
|
+
transcribe_file(
|
|
187
|
+
file_path=args.transcribe,
|
|
188
|
+
output_format=args.format,
|
|
189
|
+
output_path=args.output,
|
|
190
|
+
)
|
|
191
|
+
return
|
|
192
|
+
except Exception as e:
|
|
193
|
+
print(f"Error transcribing file: {e}", file=sys.stderr)
|
|
194
|
+
sys.exit(1)
|
|
195
|
+
|
|
196
|
+
if args.config_check:
|
|
197
|
+
from kural.config import ConfigManager
|
|
198
|
+
from kural.config.configcheck import validate_config
|
|
199
|
+
|
|
200
|
+
cm = ConfigManager(quiet=True)
|
|
201
|
+
_, issues = validate_config(cm.config)
|
|
202
|
+
print("Kural Configuration Audit:")
|
|
203
|
+
if not issues:
|
|
204
|
+
print(" ✓ All configuration keys and values are valid.")
|
|
205
|
+
else:
|
|
206
|
+
print(f" ⚠️ Found {len(issues)} anomaly/anomalies:")
|
|
207
|
+
for issue in issues:
|
|
208
|
+
print(f" • {issue}")
|
|
209
|
+
return
|
|
210
|
+
|
|
211
|
+
if args.settings:
|
|
212
|
+
from kural.ui.settings_window import open_settings_window
|
|
213
|
+
|
|
214
|
+
open_settings_window()
|
|
215
|
+
return
|
|
216
|
+
|
|
217
|
+
if args.history_gui:
|
|
218
|
+
from kural.ui.history_window import open_history_window
|
|
219
|
+
|
|
220
|
+
open_history_window()
|
|
221
|
+
return
|
|
222
|
+
|
|
223
|
+
if args.cheat_sheet:
|
|
224
|
+
from kural.ui.cheat_sheet import open_cheat_sheet
|
|
225
|
+
|
|
226
|
+
open_cheat_sheet()
|
|
227
|
+
return
|
|
228
|
+
|
|
229
|
+
if args.dict_list:
|
|
230
|
+
from kural.engine.dictionary import list_hotwords
|
|
231
|
+
|
|
232
|
+
words = list_hotwords()
|
|
233
|
+
print(f"Kural Custom Dictionary ({len(words)} words):")
|
|
234
|
+
for w in words:
|
|
235
|
+
print(f" • {w}")
|
|
236
|
+
return
|
|
237
|
+
|
|
238
|
+
if args.dict_add:
|
|
239
|
+
from kural.engine.dictionary import add_hotword
|
|
240
|
+
|
|
241
|
+
if add_hotword(args.dict_add):
|
|
242
|
+
print(f"✓ Added '{args.dict_add}' to dictionary hotwords.")
|
|
243
|
+
else:
|
|
244
|
+
print(f"✗ Word '{args.dict_add}' is already present or empty.")
|
|
245
|
+
return
|
|
246
|
+
|
|
247
|
+
if args.dict_remove:
|
|
248
|
+
from kural.engine.dictionary import remove_hotword
|
|
249
|
+
|
|
250
|
+
if remove_hotword(args.dict_remove):
|
|
251
|
+
print(f"✓ Removed '{args.dict_remove}' from dictionary hotwords.")
|
|
252
|
+
else:
|
|
253
|
+
print(f"✗ Word '{args.dict_remove}' not found in dictionary.")
|
|
254
|
+
return
|
|
255
|
+
|
|
256
|
+
if args.history is not None:
|
|
257
|
+
from kural.engine.history import search_history
|
|
258
|
+
|
|
259
|
+
results = search_history(query=args.history, limit=20)
|
|
260
|
+
label = f"Query: '{args.history}'" if args.history else "Recent Entries"
|
|
261
|
+
print(f"Kural Dictation History ({label}):")
|
|
262
|
+
if not results:
|
|
263
|
+
print(" (No matching history entries found)")
|
|
264
|
+
for r in results:
|
|
265
|
+
ts_str = r.get("ts", "")[:19].replace("T", " ")
|
|
266
|
+
task_tag = f"[{r.get('task')}]"
|
|
267
|
+
print(f" {ts_str} {task_tag:<13} {r.get('text')}")
|
|
268
|
+
return
|
|
269
|
+
|
|
270
|
+
if args.stats:
|
|
271
|
+
from kural.engine.history import compute_stats
|
|
272
|
+
|
|
273
|
+
s = compute_stats()
|
|
274
|
+
print("Kural Productivity Statistics:")
|
|
275
|
+
print(f" • Total Dictations: {s['dictations']}")
|
|
276
|
+
print(f" • Total Commands: {s['commands']}")
|
|
277
|
+
print(f" • Words Dictated: {s['total_words']:,}")
|
|
278
|
+
print(f" • Speaking Speed: {s['wpm']} WPM")
|
|
279
|
+
print(f" • Time Saved: ~{s['minutes_saved']} minutes (vs typing)")
|
|
280
|
+
print(f" • Active Streak: {s['streak_days']} day(s)")
|
|
281
|
+
if s["top_apps"]:
|
|
282
|
+
app_str = ", ".join(f"{a} ({c})" for a, c in s["top_apps"])
|
|
283
|
+
print(f" • Top Apps: {app_str}")
|
|
284
|
+
return
|
|
285
|
+
|
|
286
|
+
if args.autostart_status:
|
|
287
|
+
from kural.control.autostart import get_stored_autostart_command, is_autostart_enabled
|
|
288
|
+
|
|
289
|
+
if is_autostart_enabled():
|
|
290
|
+
print(f"✓ Kural autostart is ENABLED.\n Command: {get_stored_autostart_command()}")
|
|
291
|
+
else:
|
|
292
|
+
print("✗ Kural autostart is DISABLED (will not launch on login).")
|
|
293
|
+
return
|
|
294
|
+
|
|
295
|
+
if args.enable_autostart:
|
|
296
|
+
from kural.control.autostart import enable_autostart
|
|
297
|
+
|
|
298
|
+
if enable_autostart():
|
|
299
|
+
print("✓ Enabled Kural autostart at Windows login (windowless background mode).")
|
|
300
|
+
else:
|
|
301
|
+
print("✗ Failed to enable autostart (check platform and user permissions).")
|
|
302
|
+
return
|
|
303
|
+
|
|
304
|
+
if args.disable_autostart:
|
|
305
|
+
from kural.control.autostart import disable_autostart
|
|
306
|
+
|
|
307
|
+
if disable_autostart():
|
|
308
|
+
print("✓ Disabled Kural autostart (removed from Windows startup).")
|
|
309
|
+
else:
|
|
310
|
+
print("✗ Failed to disable autostart.")
|
|
311
|
+
return
|
|
312
|
+
|
|
313
|
+
if args.serve:
|
|
314
|
+
from kural.engine.server import run_server
|
|
315
|
+
|
|
316
|
+
sys.exit(run_server(host=args.host, port=args.port))
|
|
317
|
+
|
|
318
|
+
# Configure logging before starting the runtime
|
|
319
|
+
from kural.config import ConfigManager
|
|
320
|
+
from kural.engine.instance_manager import (
|
|
321
|
+
acquire_single_instance_lock,
|
|
322
|
+
release_single_instance_lock,
|
|
323
|
+
)
|
|
324
|
+
from kural.engine.log_setup import setup_logging
|
|
325
|
+
|
|
326
|
+
cfg = ConfigManager(quiet=True)
|
|
327
|
+
setup_logging(cfg.config)
|
|
328
|
+
|
|
329
|
+
# Acquire single-instance lock before launching background runtime
|
|
330
|
+
lock_ok, lock_handle = acquire_single_instance_lock()
|
|
331
|
+
if not lock_ok:
|
|
332
|
+
sys.exit(1)
|
|
333
|
+
|
|
334
|
+
try:
|
|
335
|
+
# Launch live background runtime
|
|
336
|
+
from kural.runtime import KuralRuntime
|
|
337
|
+
|
|
338
|
+
runtime = KuralRuntime(config_manager=cfg)
|
|
339
|
+
runtime.run()
|
|
340
|
+
finally:
|
|
341
|
+
release_single_instance_lock(lock_handle)
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
if __name__ == "__main__":
|
|
345
|
+
main()
|
kural/config/__init__.py
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# MIT License — Copyright (c) 2025 drajb (upstream: Pin Wang / whisper-key-local)
|
|
2
|
+
# Ported from drajb/whisper-local/src/whisper_key/config_manager.py
|
|
3
|
+
"""Kural configuration subsystem: defaults layering, settings validation, and hot reload."""
|
|
4
|
+
|
|
5
|
+
from .config_manager import ConfigManager
|
|
6
|
+
from .defaults_merge import load_layered
|
|
7
|
+
|
|
8
|
+
__all__ = ["ConfigManager", "load_layered"]
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
# =============================================================================
|
|
2
|
+
# KURAL - DEFAULT APPLICATION RULES & FORMATTING STYLES
|
|
3
|
+
# =============================================================================
|
|
4
|
+
# When a dictation is about to be delivered, the foreground window is inspected.
|
|
5
|
+
# If its executable name OR window title matches any string in "match", the rule
|
|
6
|
+
# applies and customizes formatting and delivery behavior.
|
|
7
|
+
#
|
|
8
|
+
# Supported overrides:
|
|
9
|
+
# suppress: true | false - skip text delivery entirely (e.g. password managers)
|
|
10
|
+
# style: verbatim | casual | formal
|
|
11
|
+
# auto_send: true | false - press ENTER after delivery (e.g. chat apps)
|
|
12
|
+
|
|
13
|
+
rules:
|
|
14
|
+
# Password managers: never deliver speech into password fields (security protection)
|
|
15
|
+
- id: password-managers
|
|
16
|
+
match:
|
|
17
|
+
- "1password"
|
|
18
|
+
- "bitwarden"
|
|
19
|
+
- "keepass"
|
|
20
|
+
- "lastpass"
|
|
21
|
+
- "dashlane"
|
|
22
|
+
suppress: true
|
|
23
|
+
|
|
24
|
+
# Command lines and terminals: format verbatim without prose punctuation
|
|
25
|
+
- id: terminals
|
|
26
|
+
match:
|
|
27
|
+
- "wt.exe"
|
|
28
|
+
- "windowsterminal.exe"
|
|
29
|
+
- "cmd.exe"
|
|
30
|
+
- "powershell.exe"
|
|
31
|
+
- "pwsh.exe"
|
|
32
|
+
- "conhost.exe"
|
|
33
|
+
- "alacritty.exe"
|
|
34
|
+
- "wezterm"
|
|
35
|
+
style: verbatim
|
|
36
|
+
|
|
37
|
+
# Code editors: identifiers and paths, no auto-capitalization or trailing period
|
|
38
|
+
- id: code-editors
|
|
39
|
+
match:
|
|
40
|
+
- "code.exe"
|
|
41
|
+
- "cursor.exe"
|
|
42
|
+
- "windsurf.exe"
|
|
43
|
+
- "pycharm"
|
|
44
|
+
- "idea64"
|
|
45
|
+
- "sublime_text"
|
|
46
|
+
- "notepad++.exe"
|
|
47
|
+
style: verbatim
|
|
48
|
+
|
|
49
|
+
# Chat apps: casual formatting, keep natural phrasing
|
|
50
|
+
- id: chat-apps
|
|
51
|
+
match:
|
|
52
|
+
- "slack"
|
|
53
|
+
- "discord"
|
|
54
|
+
- "whatsapp"
|
|
55
|
+
- "teams"
|
|
56
|
+
- "telegram"
|
|
57
|
+
style: casual
|
|
58
|
+
|
|
59
|
+
# Documents and email: formal full sentences with capitalization
|
|
60
|
+
- id: email-and-docs
|
|
61
|
+
match:
|
|
62
|
+
- "outlook"
|
|
63
|
+
- "thunderbird"
|
|
64
|
+
- "winword.exe"
|
|
65
|
+
- "word.exe"
|
|
66
|
+
- "gmail"
|
|
67
|
+
- "docs.google.com"
|
|
68
|
+
style: formal
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# =============================================================================
|
|
2
|
+
# KURAL - DEFAULT VOICE COMMANDS
|
|
3
|
+
# =============================================================================
|
|
4
|
+
# Speak a trigger phrase during command mode to run the associated command.
|
|
5
|
+
# Each command needs a "trigger" phrase and one action:
|
|
6
|
+
# "run" (shell command), "hotkey" (keypress), or "type" (deliver pre-written text).
|
|
7
|
+
|
|
8
|
+
commands:
|
|
9
|
+
# Hotkey commands — send keyboard shortcuts to the active window
|
|
10
|
+
- trigger: "undo"
|
|
11
|
+
hotkey: "ctrl+z"
|
|
12
|
+
- trigger: "select all"
|
|
13
|
+
hotkey: "ctrl+a"
|
|
14
|
+
- trigger: "copy"
|
|
15
|
+
hotkey: "ctrl+c"
|
|
16
|
+
- trigger: "paste"
|
|
17
|
+
hotkey: "ctrl+v"
|
|
18
|
+
- trigger: "paste that"
|
|
19
|
+
hotkey: "ctrl+v"
|
|
20
|
+
- trigger: "snap left"
|
|
21
|
+
hotkey: "win+left"
|
|
22
|
+
- trigger: "snap right"
|
|
23
|
+
hotkey: "win+right"
|
|
24
|
+
- trigger: "maximize"
|
|
25
|
+
hotkey: "win+up"
|
|
26
|
+
- trigger: "minimize"
|
|
27
|
+
hotkey: "win+down"
|
|
28
|
+
- trigger: "show desktop"
|
|
29
|
+
hotkey: "win+d"
|
|
30
|
+
|
|
31
|
+
# Shell commands
|
|
32
|
+
- trigger: "open notepad"
|
|
33
|
+
run: "notepad.exe"
|
|
34
|
+
- trigger: "open calculator"
|
|
35
|
+
run: "calc.exe"
|
|
36
|
+
- trigger: "open browser"
|
|
37
|
+
run: "start https://www.google.com"
|
|
38
|
+
- trigger: "open downloads"
|
|
39
|
+
run: 'explorer "%USERPROFILE%\\Downloads"'
|
|
40
|
+
- trigger: "screenshot"
|
|
41
|
+
run: "snippingtool"
|
|
42
|
+
- trigger: "lock screen"
|
|
43
|
+
run: "rundll32.exe user32.dll,LockWorkStation"
|
|
44
|
+
|
|
45
|
+
# Tamil & Tanglish voice commands
|
|
46
|
+
- trigger: "திற நோட்பேடு"
|
|
47
|
+
run: "notepad.exe"
|
|
48
|
+
- trigger: "notepad திற"
|
|
49
|
+
run: "notepad.exe"
|
|
50
|
+
- trigger: "notepad open பண்ணு"
|
|
51
|
+
run: "notepad.exe"
|
|
52
|
+
- trigger: "திற கால்குலேட்டர்"
|
|
53
|
+
run: "calc.exe"
|
|
54
|
+
- trigger: "calc open பண்ணு"
|
|
55
|
+
run: "calc.exe"
|
|
56
|
+
- trigger: "திரைப்படம் எடு"
|
|
57
|
+
run: "snippingtool"
|
|
58
|
+
- trigger: "screenshot எடு"
|
|
59
|
+
run: "snippingtool"
|
|
60
|
+
- trigger: "திரையை பூட்டு"
|
|
61
|
+
run: "rundll32.exe user32.dll,LockWorkStation"
|
|
62
|
+
- trigger: "முந்தைய செயல்"
|
|
63
|
+
hotkey: "ctrl+z"
|
|
64
|
+
- trigger: "அனைத்தும் தேர்ந்தெடு"
|
|
65
|
+
hotkey: "ctrl+a"
|
|
@@ -0,0 +1,212 @@
|
|
|
1
|
+
# =============================================================================
|
|
2
|
+
# KURAL - DEFAULT CONFIGURATION
|
|
3
|
+
# =============================================================================
|
|
4
|
+
# DO NOT EDIT THIS FILE
|
|
5
|
+
# This is the default configuration template for Kural
|
|
6
|
+
#
|
|
7
|
+
# Personal settings are stored at:
|
|
8
|
+
# Windows: %APPDATA%\kural\user_settings.yaml
|
|
9
|
+
# macOS: ~/.kural/user_settings.yaml
|
|
10
|
+
|
|
11
|
+
whisper: # Whisper AI Model Settings
|
|
12
|
+
# Backend engine
|
|
13
|
+
# - faster_whisper (default): CTranslate2-based, GPU-accelerated (RTX 3050)
|
|
14
|
+
backend: faster_whisper
|
|
15
|
+
|
|
16
|
+
# Model selection
|
|
17
|
+
# Default is 'large-v3-turbo' on GPU for optimal accuracy and speed (English + Tamil)
|
|
18
|
+
# CPU fallback: 'base' or 'small'
|
|
19
|
+
model: large-v3-turbo
|
|
20
|
+
|
|
21
|
+
# Transcription device
|
|
22
|
+
# Options: cuda (NVIDIA RTX 3050), cpu
|
|
23
|
+
device: cuda
|
|
24
|
+
|
|
25
|
+
# Compute Precision
|
|
26
|
+
# Options: float16 (for CUDA), int8 (for CPU)
|
|
27
|
+
compute_type: float16
|
|
28
|
+
|
|
29
|
+
# Automatically unload model from VRAM after N minutes of inactivity (0 to disable)
|
|
30
|
+
# Frees ~1.5 GB on RTX 3050 for other GPU workloads; reloads seamlessly on next dictation
|
|
31
|
+
idle_unload_minutes: 5
|
|
32
|
+
|
|
33
|
+
# Language selection
|
|
34
|
+
# Options: en (English), ta (Tamil), or auto (auto-detect)
|
|
35
|
+
language: en
|
|
36
|
+
|
|
37
|
+
# Indic script output style (for Tamil)
|
|
38
|
+
# Options: native (Tamil script characters), roman (Latin transliteration / Tanglish)
|
|
39
|
+
indic_script: native
|
|
40
|
+
|
|
41
|
+
# Dictation languages restricted list
|
|
42
|
+
# When language is 'auto', detection picks only from this list
|
|
43
|
+
languages:
|
|
44
|
+
- en
|
|
45
|
+
- ta
|
|
46
|
+
|
|
47
|
+
# Transcription quality settings
|
|
48
|
+
beam_size: 5
|
|
49
|
+
|
|
50
|
+
# Initial prompt to guide transcription style or script
|
|
51
|
+
initial_prompt: ""
|
|
52
|
+
|
|
53
|
+
# Custom hotwords — domain or vocabulary terms the model should favor
|
|
54
|
+
hotwords: []
|
|
55
|
+
|
|
56
|
+
# Smart prompt from selection
|
|
57
|
+
prompt_from_selection: false
|
|
58
|
+
|
|
59
|
+
# Whisper task: "transcribe" (source language) or "translate" (into English)
|
|
60
|
+
task: transcribe
|
|
61
|
+
|
|
62
|
+
# Available models
|
|
63
|
+
models:
|
|
64
|
+
large-v3-turbo:
|
|
65
|
+
label: "Large-V3-Turbo (1.5GB)"
|
|
66
|
+
group: official
|
|
67
|
+
enabled: true
|
|
68
|
+
large:
|
|
69
|
+
label: "Large-V3 (2.9GB)"
|
|
70
|
+
group: official
|
|
71
|
+
enabled: true
|
|
72
|
+
medium:
|
|
73
|
+
label: "Medium (1.4GB)"
|
|
74
|
+
group: official
|
|
75
|
+
enabled: true
|
|
76
|
+
small:
|
|
77
|
+
label: "Small (464MB)"
|
|
78
|
+
group: official
|
|
79
|
+
enabled: true
|
|
80
|
+
base:
|
|
81
|
+
label: "Base (141MB)"
|
|
82
|
+
group: official
|
|
83
|
+
enabled: true
|
|
84
|
+
tiny:
|
|
85
|
+
label: "Tiny (75MB)"
|
|
86
|
+
group: official
|
|
87
|
+
enabled: true
|
|
88
|
+
distil-large-v3.5:
|
|
89
|
+
source: Systran/faster-distil-whisper-large-v3
|
|
90
|
+
label: "Distil-Large-V3.5 (1.5GB)"
|
|
91
|
+
group: custom
|
|
92
|
+
enabled: true
|
|
93
|
+
|
|
94
|
+
audio: # Audio input configuration
|
|
95
|
+
device: default
|
|
96
|
+
host: null
|
|
97
|
+
max_duration: 30
|
|
98
|
+
channels: 1
|
|
99
|
+
whisper_mode: # Boost quiet speech / whisper mode
|
|
100
|
+
enabled: true
|
|
101
|
+
max_gain: 8.0
|
|
102
|
+
noise_suppression: # Spectral subtraction noise gating (removes fan/HVAC hum)
|
|
103
|
+
enabled: false
|
|
104
|
+
strength: 0.75 # 0.0 to 1.0 (proportion of noise reduction)
|
|
105
|
+
ducking: # Automatic playback volume ducking while dictating
|
|
106
|
+
enabled: false
|
|
107
|
+
factor: 0.25 # Lower volume to 25% of current level while speaking
|
|
108
|
+
|
|
109
|
+
hotkey: # Hotkey trigger configuration
|
|
110
|
+
recording_hotkey: "ctrl+space"
|
|
111
|
+
stop_key: "ctrl | macos: fn"
|
|
112
|
+
auto_send_key: ""
|
|
113
|
+
command_hotkey: "ctrl+shift+space"
|
|
114
|
+
paste_last_hotkey: "ctrl+alt+v"
|
|
115
|
+
cancel_hotkey: "escape" # Discard recording without transcribing or pasting (Hex-inspired)
|
|
116
|
+
recording_mode: toggle # toggle or push_to_talk
|
|
117
|
+
mouse_button: ""
|
|
118
|
+
double_tap_to_lock: false
|
|
119
|
+
stop_phrase: # Hands-free voice stop phrase detection (Hex-inspired)
|
|
120
|
+
enabled: false
|
|
121
|
+
phrases:
|
|
122
|
+
- "stop dictation"
|
|
123
|
+
- "stop recording"
|
|
124
|
+
- "முடி"
|
|
125
|
+
- "நிறுத்து"
|
|
126
|
+
- "stop பண்ணு"
|
|
127
|
+
|
|
128
|
+
clipboard: # Insertion settings
|
|
129
|
+
auto_paste: true
|
|
130
|
+
restore_clipboard: true
|
|
131
|
+
return_to_app: true # Refocus the window dictation started in if another window stole focus (Hex-inspired)
|
|
132
|
+
delivery_method: paste # paste (Ctrl+V), type (Unicode keystrokes), or copy (clipboard only)
|
|
133
|
+
|
|
134
|
+
logging: # Logging configuration
|
|
135
|
+
level: INFO
|
|
136
|
+
log_transcriptions: false
|
|
137
|
+
file:
|
|
138
|
+
enabled: true
|
|
139
|
+
filename: "kural.log"
|
|
140
|
+
max_bytes: 1048576 # 1 MB
|
|
141
|
+
backup_count: 3
|
|
142
|
+
|
|
143
|
+
vad: # Voice activity detection
|
|
144
|
+
precheck_enabled: true
|
|
145
|
+
realtime_enabled: false
|
|
146
|
+
vad_onset_threshold: 0.7
|
|
147
|
+
vad_offset_threshold: 0.55
|
|
148
|
+
vad_min_speech_duration: 0.1
|
|
149
|
+
vad_silence_timeout_seconds: 20.0
|
|
150
|
+
|
|
151
|
+
streaming: # Real-time streaming recognizer (optional)
|
|
152
|
+
enabled: false
|
|
153
|
+
deliver_to_cursor: false
|
|
154
|
+
model: standard
|
|
155
|
+
models: {}
|
|
156
|
+
|
|
157
|
+
postprocess: # Text cleanup and formatting
|
|
158
|
+
remove_stutter: true
|
|
159
|
+
backtrack: true
|
|
160
|
+
format_lists: true
|
|
161
|
+
styles: {}
|
|
162
|
+
corrections: {}
|
|
163
|
+
snippets: # Inline spoken text expansions
|
|
164
|
+
- trigger: "today's date"
|
|
165
|
+
expansion: "${date}"
|
|
166
|
+
- trigger: "current time"
|
|
167
|
+
expansion: "${time}"
|
|
168
|
+
- trigger: "insert clipboard"
|
|
169
|
+
expansion: "${clipboard}"
|
|
170
|
+
|
|
171
|
+
recovery: # Never-lose-a-dictation audio and text retention
|
|
172
|
+
enabled: true
|
|
173
|
+
max_age_hours: 24 # DPAPI encrypted take expires after N hours
|
|
174
|
+
|
|
175
|
+
voice_commands: # Voice control engine
|
|
176
|
+
enabled: true
|
|
177
|
+
fuzzy_match: true
|
|
178
|
+
guardrails: true
|
|
179
|
+
|
|
180
|
+
ui: # User interface preferences
|
|
181
|
+
theme: system
|
|
182
|
+
|
|
183
|
+
overlay: # Floating visual status pill (Wispr-style screen edge overlay)
|
|
184
|
+
enabled: true
|
|
185
|
+
position: "bottom-center" # bottom-center, top-center
|
|
186
|
+
click_through: true # Allow mouse clicks to pass through to windows below
|
|
187
|
+
|
|
188
|
+
system_tray: # Windows notification area / tray icon
|
|
189
|
+
enabled: true
|
|
190
|
+
|
|
191
|
+
audio_feedback: # Audible confirmation cues for recording start/stop/done
|
|
192
|
+
enabled: true
|
|
193
|
+
start_sound: "" # Custom .wav file path, or empty for native chime
|
|
194
|
+
stop_sound: ""
|
|
195
|
+
complete_sound: ""
|
|
196
|
+
error_sound: ""
|
|
197
|
+
|
|
198
|
+
stats:
|
|
199
|
+
typing_wpm: 40
|
|
200
|
+
|
|
201
|
+
llm_fallback: # Optional local language model intent fallback (off by default)
|
|
202
|
+
enabled: false
|
|
203
|
+
model_path: "" # Path to local .gguf or ONNX model
|
|
204
|
+
timeout_sec: 6.0
|
|
205
|
+
|
|
206
|
+
wake_word: # Optional hands-free keyword activation (off by default)
|
|
207
|
+
enabled: false
|
|
208
|
+
trigger_phrase: "kural" # Activation keyword (e.g. "kural" or "குரல்")
|
|
209
|
+
sensitivity: 0.6
|
|
210
|
+
|
|
211
|
+
notes: # Voice notes and Obsidian vault quick-capture
|
|
212
|
+
vault_path: "" # Path to Obsidian vault or custom notes directory (empty = Documents/Kural Notes)
|