⬟ SL5 Aura – Votre voix. Vos règles.¶
Cadre d’assistant vocal 100 % hors ligne, axé sur la confidentialité.
Définissez exactement ce que fait votre voix - à partir d’un seul mot
aux scripts Python complets. Pas de nuage. Aucune donnée ne quitte votre ordinateur.
S’exécute dans un terminal, un navigateur ou en tant que service d’arrière-plan — sous Linux, macOS et Windows.
👵 Débutant |
🎓 Apprenant |
🧑u200d💻 Développeur |
|---|
| grandma-mode : écrivez simplement un mot, Aura fait le reste | Apprenez avec Koans — un concept à la fois | Scripts Python complets, plugins, appels API | | 🗄️ Gestion de l’État | Orchestration Trino + Airflow, fzf, CopyQ, commandes vocales/terminal, interfaces utilisateur du navigateur |
⚡ ~2,87 J par test (39 tests sur >800 cartes à 0,09 s à chaud / 0,45 s à froid 🌿 mesuré avec Eco-CI) · pas de calcul cloud
<détails>
Démarrage rapide¶
Téléchargez ou clonez ce référentiel
Exécutez le script d’installation pour votre système d’exploitation (voir le dossier
setup/) :
Linux (Arch/Manjaro) :
bash setup/manjaro_arch_setup.sh===> 🧩 lire docs/LINUX_WAYLAND_dotoolLinux (Ubuntu/Debian) :
bash setup/ubuntu_setup.shLinux (openSUSE) :
bash setup/suse_setup.shLinux (NixOS) :
nix-shell setup/shell.nixpuisbash setup/nixos_setup.sh===> ⚠️ Expérimental — non testé par les auteurs, commentaires bienvenus !macOS :
bash setup/macos_setup.shWindows :
setup/windows11_setup_with_ahk_copyq.bat
Démarrez Aura :
./scripts/restart_venv_and_run-server.shAppuyez sur votre touche de raccourci et parlez — full guide →
⚠️ Configuration système requise et compatibilité
Windows : ✅ Entièrement pris en charge (utilise AutoHotkey/PowerShell).
macOS : ✅ Entièrement pris en charge (utilise AppleScript).
Linux (X11/Xorg) : ✅ Entièrement pris en charge.
Linux (Wayland) : ✅ Entièrement pris en charge (testé sur KDE Plasma 6 / Wayland).
Linux (version continue basée sur CachyOS / Arch) : ✅ Entièrement pris en charge. Nécessite mimalloc (
sudo pacman -S mimalloc) en raison de la compatibilité avec la glibc 2.43.Linux (NixOS) : 🧪 Expérimental — configuration fournie par la communauté, pas encore testée. Si vous l’essayez, veuillez ouvrir un problème ou un PR avec vos découvertes !
Linux (Manjaro) : Nouveau / expérimental : un raccourci clavier à l’échelle du système ouvre une interface pilotée par clavier de type fzf afin que vous puissiez exécuter des commandes Aura depuis n’importe où sur le bureau (complètement découplé de la fenêtre active). Ce lanceur piloté par raccourci clavier est actuellement implémenté et testé sur Linux (Manjaro) ; d’autres distributions peuvent fonctionner mais nécessitent la configuration. Voir dans 👉 docs/Feature_Spotlight/CopyQ_Shortcut_Super_s.md
SL5 Aura est un assistant vocal hors ligne complet, basé sur Vosk (pour la synthèse vocale) et LanguageTool (pour la grammaire/le style), avec un Local LLM (Ollama) Fallback en option pour des réponses créatives et une correspondance floue avancée. Il transforme votre voix en actions et en texte précis, conçus pour une personnalisation ultime grâce à un système de règles enfichable et un moteur de script dynamique.
Traductions : Ce document existe également en other languages.
Remarque : De nombreux textes sont des traductions générées automatiquement de la documentation originale en anglais et sont uniquement destinés à des conseils généraux. En cas de divergences ou d’ambiguïtés, la version anglaise prévaut toujours. Nous apprécions l’aide de la communauté pour améliorer cette traduction !
</détails>
<détails>
📺 Démo du terminal¶
Conseil : Pour une meilleure expérience de terminal, consultez Zsh Integration.
🎥 Tutoriel vidéo¶
(Lien alternatif : skipvids.com)
</détails>
<détails>
Principales fonctionnalités¶
Hors ligne et privé : 100 % local. Aucune donnée ne quitte votre machine.
Moteur de script dynamique : Allez au-delà du remplacement de texte. Les règles peuvent exécuter des scripts Python personnalisés (
on_match_exec) pour effectuer des actions avancées telles que l’appel d’API (par exemple, rechercher sur Wikipédia), interagir avec des fichiers (par exemple, gérer une liste de tâches) ou générer du contenu dynamique (par exemple, un message d’accueil par e-mail contextuel).Règles contextuelles : Restreindre les règles à des applications spécifiques. En utilisant
only_in_windows, vous pouvez garantir qu’une règle ne se déclenche que si un titre de fenêtre spécifique (par exemple, “Terminal”, “VS Code” ou “Navigateur”) est actif. Cela fonctionne sur plusieurs plates-formes (Linux, Windows, macOS).Moteur de transformation à contrôle élevé : implémente un pipeline de traitement hautement personnalisable et basé sur la configuration. La priorité des règles, la détection des commandes et les transformations de texte sont déterminées uniquement par l’ordre séquentiel des règles dans les cartes floues, nécessitant une configuration, pas un codage.
Utilisation conservatrice de la RAM : Gère intelligemment la mémoire, en préchargeant les modèles uniquement si suffisamment de RAM libre est disponible, garantissant ainsi que les autres applications (comme vos jeux PC) ont toujours la priorité.
Multiplateforme : Fonctionne sous Linux, macOS et Windows.
Entièrement automatisé : Gère son propre serveur LanguageTool (mais vous pouvez également en utiliser un externe).
Blazing Fast : La mise en cache intelligente garantit des notifications instantanées « Écoute … » et un traitement rapide.
Gestion dynamique de l’état via Trino : Moteur de configuration prenant en charge l’interface sépare les paramètres pour « parole », « terminal » et « web » - en modifiez-un sans affectant les autres. Comprend un Tableau de bord d’administration en temps réel (port 8084). </détails>
<détails>
🔌 Intégrations prêtes à l’emploi¶
SL5-Aura est livré avec un vaste écosystème de plus de 100+ plugins préconfigurés. Voici quelques faits saillants :
Commande vocale OculiX / SikuliX IDE¶
SL5-Aura offre une prise en charge vocale de première classe pour OculiX et SikuliX IDE. Cette intégration vous permet de « parler » votre code d’automatisation.
Voice-to-Snippet : Dites « cliquez », « attendez » ou « tout trouver », et le service tape instantanément le code Python correct (par exemple,
click("image.png")) dans l’EDI.Window-Aware : Le plugin est sensible au contexte ; il ne s’active que lorsque la fenêtre OculiX/SikuliX est focalisée.
Support intelligent en anglais : Optimisé pour « en-US » avec un accent particulier sur les accents non natifs (par exemple, la phonétique allemand-anglais), garantissant une grande précision de reconnaissance pour la communauté mondiale.
Extensible : Utilise le format
FUZZY_MAP_pre.pyfacile à modifier.
Statut : Reconnu comme plugin communautaire par l’équipe OculiX (voir Issue #204).
Commande vocale de l’EDI LibreOffice¶
0 A.D. Commande vocale¶
</détails>
<détails>
##Documents
Pour une référence technique complète, y compris tous les modules et scripts, veuillez visiter notre page de documentation officielle. Il est généré automatiquement et toujours à jour.
Pleins feux sur les fonctionnalités¶
Interactive Rule Search & Run — Recherche de règles
fzfà double volet, aperçus du contexte en direct, exécution instantanée de commandes viaEntrée/Ctrl+Ret intégration de l’éditeur viaCtrl+E. Pris en charge par un raccourci clavier global (Super+S) et plusieurs environnements de recherche dédiés préconfigurés via des commandes vocales.
État de la construction¶
</détails>
👉 Lisez ceci dans d’autres langues :
🇬🇧 English | 🇸🇦 العربية | 🇩🇪 Deutsch | 🇪🇸 Español | 🇫🇷 Français | 🇮🇳 हिन्दी | 🇯🇵 日本語 | 🇰🇷 한국어 | 🇵🇱 Polski | 🇵🇹 Português | 🇧🇷 Português Brasil | 🇨🇳 简体中文
<détails>
##Installation
🎥 Installation rapide sans modération (Manjaro/Arch Video)¶
Regardez le processus de configuration complet de 6 minutes :
Télécharger : ~3 minutes
Installation et premier démarrage : ~3 minutes (y compris l’assistant de bienvenue)
👉SL5 Aura Installation Live-Demo on YouTube
La configuration est un processus en deux étapes :
Téléchargez la dernière version ou master ( https://github.com/sl5net/SL5-aura-service/archive/master.zip ) ou clonez ce référentiel sur votre ordinateur.
Exécutez le script d’installation unique pour votre système d’exploitation.
Les scripts d’installation gèrent tout : les dépendances du système, l’environnement Python et le téléchargement des modèles et outils nécessaires (~ 4 Go) directement depuis nos versions GitHub pour une vitesse maximale.
Pour Linux, macOS et Windows (avec exclusion de langue facultative)¶
Pour économiser de l’espace disque et de la bande passante, vous pouvez exclure des modèles de langage spécifiques (de, en) ou tous les modèles facultatifs (all) lors de l’installation. Les composants de base (LanguageTool, lid.176) sont toujours inclus.
Ouvrez un terminal dans le répertoire racine du projet et exécutez le script pour votre système :
# For Ubuntu/Debian, Manjaro/Arch, macOS, or other derivatives
# (Note: Use bash or sh to execute the setup script)
bash setup/{your-os}_setup.sh [OPTION]
# For Arch-based systems (Manjaro, CachyOS, EndeavourOS, etc.):
`bash setup/manjaro_arch_setup.sh`
`sudo pacman -S mimalloc`
# Examples:
# Install everything (Default):
# bash setup/manjaro_arch_setup.sh
# Exclude German models:
# bash setup/manjaro_arch_setup.sh exclude=de
# Exclude all VOSK language models:
# bash setup/manjaro_arch_setup.sh exclude=all
# For Windows in an Admin-Powershell session
setup/windows11_setup.ps1 -Exclude [OPTION]
# Examples:
# Install everything (Default):
# setup/windows11_setup.ps1
# Exclude English models:
# setup/windows11_setup.ps1 -Exclude "en"
# Exclude German and English models:
# setup/windows11_setup.ps1 -Exclude "de,en"
# Or (recommend) - Run the BAT file:
windows11_setup.bat -Exclude "en"
Pour Windows¶
Exécutez le script d’installation avec les privilèges d’administrateur.
Installez un outil pour lire et exécuter, par exemple CopyQ ou AutoHotkey v2. Ceci est requis pour l’observateur de saisie de texte.
L’installation est entièrement automatisée et prend environ 8 à 10 minutes lors de l’utilisation de 2 modèles sur un nouveau système.
Accédez au dossier « setup ».
Double-cliquez sur
windows11_setup_with_ahk_copyq.bat.
Le script demandera automatiquement les privilèges d’administrateur.
Il installe le système principal, les modèles de langage, AutoHotkey v2 et CopyQ.
Une fois l’installation terminée, Aura Dictation se lancera automatiquement.
Remarque : Vous n’avez pas besoin d’installer Python ou Git au préalable ; le script gère tout.
Installation avancée/personnalisée¶
Si vous préférez ne pas installer les outils clients (AHK/CopyQ) ou souhaitez économiser de l’espace disque en excluant des langues spécifiques, vous pouvez exécuter le script principal via la ligne de commande :
# Core Setup only (No AHK, No CopyQ)
setup/windows11_setup_with_ahk_copyq.bat
# Exclude specific language models (saves space):
# Exclude English:
setup/windows11_setup_with_ahk_copyq.bat -Exclude "en"
# Exclude German and English:
setup/windows11_setup_with_ahk_copyq.bat -Exclude "de,en"
</détails>
<détails>
Utilisation¶
1. Démarrez les services¶
Sous Linux et macOS¶
Un seul script gère tout. Il démarre automatiquement le service de dictée principal et l’observateur de fichiers en arrière-plan.
# Run this from the project's root directory
./scripts/restart_venv_and_run-server.sh
Sous Windows¶
Le démarrage du service est un processus manuel en deux étapes :
Démarrez le service principal : Exécutez
start_aura.bat. ou démarrez à partir de.venvle service avecpython3
2. Configurez votre raccourci clavier¶
Pour déclencher la dictée, vous avez besoin d’un raccourci clavier global qui crée un fichier spécifique. Nous recommandons fortement l’outil multiplateforme CopyQ.
Notre recommandation : CopyQ¶
Créez une nouvelle commande dans CopyQ avec un raccourci global.
Commande pour Linux/macOS :
touch /tmp/sl5_record.trigger
Commande pour Windows lors de l’utilisation de CopyQ :
copyq:
var filePath = 'c:/tmp/sl5_record.trigger';
var f = File(filePath);
if (f.openAppend()) {
f.close();
} else {
popup(
'error',
'cant read or open:\n' + filePath
+ '\n' + f.errorString()
);
}
Commande pour Windows lors de l’utilisation de AutoHotkey :
; trigger-hotkeys.ahk
; AutoHotkey v2 Skript
#SingleInstance Force ; Stellt sicher, dass nur eine Instanz des Skripts läuft
;===================================================================
; Hotkey zum Auslösen des Aura Triggers
; Drücke Strg + Alt + T, um die Trigger-Datei zu schreiben.
;===================================================================
f9::
f10::
f11::
{
local TriggerFile := "c:\tmp\sl5_record.trigger"
FileAppend("t", TriggerFile)
ToolTip("Aura Trigger ausgelöst!")
SetTimer(() => ToolTip(), -1500)
}
3. Commencez à dicter !¶
Cliquez dans n’importe quel champ de texte, appuyez sur votre touche de raccourci et une notification “Écoute…” apparaîtra. Parlez clairement, puis faites une pause. Le texte corrigé sera tapé pour vous.
</détails>
<détails>
Configuration avancée (facultatif)¶
Vous pouvez personnaliser le comportement de l’application en créant un fichier de paramètres local.
Accédez au répertoire
config/.Créez une copie de
config/settings_local.py_Example.txtet renommez-la enconfig/settings_local.py.Modifiez
config/settings_local.py(il remplace tout paramètre du fichier principalconfig/settings.py).
Ce fichier config/settings_local.py est ignoré par Git par défaut, donc vos modifications personnelles ne seront pas écrasées par les mises à jour.
Structure et logique du plug-in¶
La modularité du système permet une extension robuste via le répertoire plugins/.
Le moteur de traitement adhère strictement à une Chaîne de priorités hiérarchique :
Ordre de chargement des modules (haute priorité) : Les règles chargées à partir des modules linguistiques principaux (de-DE, en-US) ont priorité sur les règles chargées à partir du répertoire plugins/ (qui se chargent en dernier par ordre alphabétique).
Ordre dans le fichier (micro-priorité) : Dans tout fichier de carte donné (FUZZY_MAP_pre.py), les règles sont traitées strictement par numéro de ligne (de haut en bas).
Cette architecture garantit que les règles de base du système sont protégées, tandis que les règles spécifiques au projet ou sensibles au contexte (comme celles de CodeIgniter ou des contrôles de jeu) peuvent être facilement ajoutées en tant qu’extensions de faible priorité via des plug-ins.
</détails>
<détails>
Scripts clés pour les utilisateurs Windows¶
Voici une liste des scripts les plus importants pour configurer, mettre à jour et exécuter l’application sur un système Windows.
Configuration et mise à jour¶
chmod +x update.sh ; ./update.shsetup/setup.bat: Le script principal pour la configuration initiale unique de l’environnement.or
Exécutez PowerShell -Command "Set-ExecutionPolicy -ExecutionPolicy Bypass -Scope Process -Force; .\setup\windows11_setup.ps1"update.bat: exécutez ceci à partir du dossier du projet pour obtenir le dernier code et les dernières dépendances.
Exécution de l’application¶
start_aura.bat: Un script principal pour démarrer le service de dictée.
Scripts de base et d’assistance¶
aura_engine.py: le service Python principal (généralement démarré par l’un des scripts ci-dessus).get_suggestions.py: Un script d’assistance pour des fonctionnalités spécifiques.
</détails>
🚀 Principales fonctionnalités et compatibilité du système d’exploitation¶
<détails>
Légende de compatibilité du système d’exploitation :
🐧 Linux (par exemple, Arch, Ubuntu)
🍏 macOS
🪟 Windows
📱 Android (pour les fonctionnalités spécifiques aux mobiles)
</détails>
Moteur principal de synthèse vocale (Aura)¶
Notre principal moteur de reconnaissance vocale et de traitement audio hors ligne.
<détails>
SystemUtilities/
├┬ LanguageTool Server Management/
│├─ start_languagetool_server.py (Initializes the local LanguageTool server) 🐧 🍏 🪟
│└─ stop_languagetool_server.py (Shuts down the LanguageTool server) 🐧 🍏
├─ monitor_mic.sh (e.g. for use with Headset without use keyboard and Monitor) 🐧 🍏 🪟
Model & Package Management¶
Tools for robust handling of large language models.
ModelManagement/ 🐧 🍏 🪟
├─ Robust Model Downloader (GitHub Release chunks) 🐧 🍏 🪟
├─ split_and_hash.py (Utility for repo owners to split large files and generate checksums) 🐧 🍏 🪟
└─ download_all_packages.py (Tool for end-users to download, verify, and reassemble multi-part files) 🐧 🍏 🪟
</détails>
<détails>
<summary>Aide au développement et au déploiement</summary>
### **Aide au développement et au déploiement**
Scripts pour la configuration de l'environnement, les tests et l'exécution des services.
*Astuce : glogg vous permet d'utiliser des expressions régulières pour rechercher des événements intéressants dans vos fichiers journaux.*
Veuillez cocher la case lors de l'installation pour l'associer aux fichiers journaux.
https://translate.google.com/translate?hl=de&sl=en&tl=fr&u=https://glogg.bonnefon.org/
*Conseil : après avoir défini vos modèles d'expression régulière, exécutez « python3 tools/map_tagger.py » pour générer automatiquement des exemples consultables pour les outils CLI. Voir [Map Maintenance Tools](../docs/Developer_Guide/Map_Maintenance_Tools.i18n/Map_Maintenance_Tools-frlang.md) pour plus de détails.*
Alors peut-être double-cliquez
`log/aura_engine.log`
**DevHelpers/**
├┬ **Gestion de l'environnement virtuel/**
│├ `scripts/restart_venv_and_run-server.sh` (Linux/macOS) 🐧 🍏
│└ `scripts/restart_venv_and_run-server.ahk` (Windows) 🪟
├┬ **Intégration de dictée à l'échelle du système/**
│├ Intégration Vosk-System-Listener 🐧 🍏 🪟
│├ `scripts/monitor_mic.sh` (surveillance des microphones spécifiques à Linux) 🐧
│└ `scripts/type_watcher.ahk` (AutoHotkey écoute le texte reconnu et le tape dans tout le système) 🪟
└─ **Automation CI/CD/**
└─ Workflows GitHub étendus (installation, tests, déploiement de documents) 🐧 🍏 🪟 *(S'exécute sur les actions GitHub)*
</détails>
<détails>
<summary>Fonctionnalités expérimentales</summary>
### **Fonctionnalités à venir/expérimentales**
Fonctionnalités actuellement en cours de développement ou à l'état de projet.
**Fonctionnalités expérimentales/**
├─ **ENTER_AFTER_DICTATION_REGEX** Exemple de règle d'activation "(ExampleAplicationThatNotExist|Pi, votre IA personnelle)" 🐧
├┬Plugins
│╰┬ **Live Lazy-Reload** (*) 🐧 🍏 🪟
(*Les modifications apportées à l'activation/désactivation du plug-in et à leurs configurations sont appliquées lors de la prochaine exécution du traitement sans redémarrage du service.*)
│ ├ **commandes git** (Contrôle vocal pour envoyer des commandes git) 🐧 🍏 🪟
│ ├ **wannweil** (Carte de localisation Allemagne-Wannweil) 🐧 🍏 🪟
│ ├ **Poker Plugin (Draft)** (Contrôle vocal pour les applications de poker) 🐧 🍏 🪟
│ └ **0 A.D. Plugin (Draft)** (Commande vocale pour le jeu 0 A.D.) 🐧
├─ **Sortie sonore au démarrage ou à la fin d'une session** (Description en attente) 🐧
├─ **Sortie vocale pour les malvoyants** (Description en attente) 🐧 🍏 🪟
└─ **Prototype Android SL5 Aura** (Pas encore entièrement hors ligne) 📱
---
*(Remarque : des distributions Linux spécifiques comme Arch (ARL) ou Ubuntu (UBT) sont couvertes par le symbole général Linux 🐧. Des distinctions détaillées peuvent être couvertes dans les guides d'installation.)*
</détails>
<détails>
<summary>Cliquez pour voir la commande utilisée pour générer cette liste de scripts</summary>
```bash
{ find . -maxdepth 1 -type f \( -name "aura_engine.py" -o -name "get_suggestions.py" \) ; find . -path "./.venv" -prune -o -path "./.env" -prune -o -path "./backup" -prune -o -path "./LanguageTool-6.6" -prune -o -type f \( -name "*.bat" -o -name "*.ahk" -o -name "*.ps1" \) -print | grep -vE "make.bat|notification_watcher.ahk"; }
</détails>
<détails>
Un aperçu graphique de l’architecture :¶
</détails>
<détails>
Modèles utilisés :¶
Recommandation : utilisez les modèles de Mirror https://github.com/sl5net/SL5-aura-service/releases/tag/v0.2.0.1 (probablement plus rapide)
Ces modèles compressés doivent être enregistrés dans le dossier models/
mv vosk-model-*.zip modèles/
Modèle |
Taille |
Taux d’erreur de mot/Vitesse |
Remarques |
Licence |
|---|---|---|---|---|
1,8G |
5,69 (librispeech test-clean) |
Modèle générique précis en anglais américain |
Apache2.0 |
|
1,9G |
9,83 (Tuda-de test) |
Grand modèle allemand de téléphonie et de serveur |
Apache2.0 |
Ce tableau donne un aperçu des différents modèles Vosk, y compris leur taille, leur taux d’erreur de mots ou leur vitesse, leurs notes et leurs informations de licence.
Modèles Vosk : Vosk-Model List
LanguageTool :
(6.6) https://languagetool.org/download/
Licence de LanguageTool : GNU Lesser General Public License (LGPL) v2.1 or later
</détails>
Soutenez le projet¶
Si vous trouvez cet outil utile, pensez à nous offrir un café ! Votre soutien contribue à alimenter les améliorations futures.
