ℹ️ This is a machine-translated document. In case of discrepancies, refer to the original document.

⬟ SL5 Aura Logo

⬟ SL5 气场 – 你的声音。你的规则。

Stack Overflow Python Privacy Latency License: MIT

100% 离线，隐私优先的语音助手框架。
准确地定义你的声音所做的——从一个单词开始
完整的 Python 脚本。不使用云。数据不会离开你的机器。
可以在终端、浏览器中运行，或作为后台服务运行——在 Linux、macOS 和 Windows 上。

👵 初学者

🎓 学习者

🧑‍💻 开发者

grandma-mode：只需写一个词，Aura 会完成其余部分

与 Koans 一起学习——一次一个概念

完整的 Python 脚本、插件、API 调用

🗄️ 状态管理

Trino + Airflow 编排, fzf, CopyQ, 语音/终端命令, 浏览器用户界面

Energy Consumption

⚡ 每次测试约 2.87 焦耳（在超过 800 张地图上进行的 39 次测试，不使用 LanguageTool，热启动 0.07 秒 / 冷启动 0.36 秒 🌿，使用 Eco-CI 测量）· 无云计算

Energy Consumption

⚡ 完整测试套件： 使用 LanguageTool 对超过 800 张地图进行 94 个测试，预热时间 0.07 秒 / 冷启动时间 0.46 秒 · 无云计算

快速开始

快速开始

选项 A：一键安装 & 网络安装程序（推荐）

适用于 Linux、macOS 和 Windows 的单行命令或独立安装程序：

  • 备选案文B:手动安装(开发者/吉特)

  1. 下载或复制此寄存器

  2. 运行您的 OS 的设置脚本( 见 XINLIN ECODE0X 文件夹 ):

    • Linux (Arch/Manjaro): bash setup/manjaro_arch_setup.sh (中文(简体) ).

    • Linux (Ubuntu/Debian): bash setup/ubuntu_setup.sh (英语).

    • Linux (openSUSE): bash setup/suse_setup.sh (中文(简体) ).

    • Linux (NixOS): nix-shell setup/shell.nix后为bash setup/nixos_setup.sh then. QQ实验——作者未试,反馈欢迎!.

    • macOS: bash setup/macos_setup.sh (英语).

    • 视窗: setup/windows11_setup_with_ahk_copyq.bat

  3. 启动 Aura: ./scripts/restart_venv_and_run-server.sh

  4. 按下你的热门键,然后说话。

解装 要删除 SL5 Aura 的背景服务、 自动启动条目和虚拟环境 :

  • ** Linux / macOS:** bash setup/uninstall.sh 互联网档案馆的存檔,存档日期2013-12-02.

  • ** Windows(PowerShell):** powershell -File setup/uninstall.ps1 (英语). *(您在 config/maps/ 中的自定义规则默认保存安全,除非您指定了 --purge). *

系统要求和兼容性 * *

  • ** Windows:** 完全支持(使用AutoHotkey/PowerShell).

  • macOS: QQ 完全支持(使用 AppleScript).

  • ** 利纳克斯(X11/Xorg):** 完全支持。

  • ** Linux (Wayland):** 完全支持(在 KDE Plasma 6 / Wayland上测试).

  • ** Linux (CachyOS / 基于 Arch的滚动发布):** QQ 完全支持。 由于 glibc 2.43 相容性,需要 mimalloc (sudo pacman -S mimalloc) .

  • Linux (NixOS): QQ实验——社区贡献设置,尚未测试. 如果你尝试,请打开一个问题 或公关与你的发现!

  • ** 利努克(马尼亚罗):** 新:全系统的热键打开了类似fzf,键盘驱动的接口,这样就可以从桌面上的任何位置运行Aura命令(完全从活动窗口解开). 这一由热键驱动的发射装置目前正在Linux(曼扎罗)上实施并测试; 其他分发可能可行,但需要设置。 见docs/Feature_Spotlight/CopyQ_Shortcut_Super_s.md

SL5 Aura是一个完整的,离线语音助理,基于Vosk(用于语音到文本)和语言工具(用于语法/Style),其特点是一个可选的本地LLM(Ollama)倒置,用于创造性响应和高级模糊匹配. 它将你的声音转化为精确的动作和文字,通过可插接的规则系统和动态脚本引擎来设计最终定制.

翻译: 该文件也存在于other languages.

注:许多文本是英文文件原件的机器翻译,仅供一般指导之用。 如果不一致或含糊不清,英文文本总是优先。 我们欢迎社区帮助改进翻译工作!

演示

📺 终端演示

Terminal Demo

提示： 为了获得更好的终端体验，请参见 Zsh Integration。

🎥 视频教程

SL5 Aura: HowTo crash SL5 Aura?

(备用链接：skipvids.com)

主要特点

□ 关键特性

  • ** Offline & Private:** 100%本地。 没有数据离开你的机器。

  • ** 动态脚本引擎:** 超越文本替换。 规则可以执行自定义的 Python 脚本(on_match_exec)来进行高级动作,如调用API(例如搜索维基百科),与文件互动(例如管理待办事宜列表),或生成动态内容(例如了解上下文的电子邮件问候).

  • ** 实用规则:** 将规则限于具体应用。 使用only_in_windows,只有在特定窗口标题(如”Terminal”,”VS代码”或”浏览器”)活动时,才能确保规则触发. 这个工作跨平台(Linux,Windows,macOS).

  • ** 高控制转换引擎:** 实施配置驱动,高度自定义的加工管线. 规则优先权,命令检测,和文本转换完全由”模糊地图”中规则的相继顺序决定,需要配置,而不是编码.

  • ** 保守内存的使用:** 智能管理内存,只有在有足够的免费RAM可用的情况下才会预装模型,确保其他应用程序(如你的PC游戏)总是有优先权.

  • ** 交叉平台:** 在Linux,macOS,和Windows上工作.

  • ** Fully Automatic:** 管理自己的语言工具服务器(但也可以使用外部服务器).

  • ** Blazing Fast:** 智能缓存可确保即时”听…”通知并快速处理.

  • ** 国家管理动态,通过Trino:** 界面感知配置引擎 将 speech 、 terminal 和 web 的设置区分开来 — 在不修改的情况下更改一个 影响他人. 包括一个实时的Admin Dashboard(8084港)。

准备使用整合

🔌 即用集成

SL5-Aura 配备了一个庞大的生态系统，拥有超过 100 个预配置插件。以下是一些亮点：

OculiX / SikuliX IDE 语音控制器 SL5-Aura为奥库利X和SikulIX IDE提供一等语音支持. 这种集成使您能够”说出”您的自动化代码.

  • ** 对片段:** 表示”点击”,”等”,或”查找全部”,服务即刻将正确的Python代码(如click("image.png"))输入到IDE.

  • ** Window-Award:** 该插件对上下文敏感;它只在OculiX/SikuliX窗口被聚焦时激活.

  • ** Smart English Support:** 为en-US所优化,并特别关注非本土口音(如德英口音),确保了全球社会的高度识别精度.

  • ** 可延长:** 使用易编辑的FUZZY_MAP_pre.py格式.

** 现状:** 被OculiX团队确认为社区插座(参见Issue #204).

LibreOffice IDE 语音控制

公元前0年 声控

文档

□ 文档

🔍 Interactive Search (Algolia)

关于包括所有模块和脚本在内的完整技术参考,请访问我们的正式文件页。 它是自动生成的,并且总是最新的.

🇬🇧 English | 🇸🇦 العربية | 🇩🇪 Deutsch | 🇪🇸 Español | 🇫🇷 Français | 🇮🇳 हिन्दी | 🇯🇵 日本語 | 🇰🇷 한국어 | 🇵🇱 Polski | 🇵🇹 Português | 🇧🇷 Português Brasil | 🇨🇳 简体中文

功能亮点

  • Interactive Rule Search & Run——双面板 fzf 规则搜索，实时上下文预览，通过 Enter/Ctrl+R 即时执行命令，并通过 Ctrl+E 集成编辑器。支持全局快捷键（Super+S）和通过语音命令预配置的多个专用搜索环境。

构建状态

Linux Manjaro Linux Ubuntu Linux Suse

macOS Windows 11

OculiX Compatible

👉 用其他语言阅读本文：

🇬🇧 English | 🇸🇦 العربية | 🇩🇪 Deutsch | 🇪🇸 Español | 🇫🇷 Français | 🇮🇳 हिन्दी | 🇯🇵 日本語 | 🇰🇷 한국어 | 🇵🇱 Polski | 🇵🇹 Português | 🇧🇷 Português Brasil | 🇨🇳 简体中文

安装

安装

QQ 快速安装不节制(马扎罗/Arch视频) 观看完整的6分钟设置过程 :

  • ** 下载:~3分钟

  • ** Setup & First Start: ** ~3分钟(包括欢迎向导)

👉 SL5 Aura Installation Live-Demo on YouTube

设置是一个分两步走的过程:

  1. 下载最新版本或主机(https://github.com/sl5net/SL5-aura-service/archive/master.zip)或复制此寄存器到您的计算机中 。

  2. 运行您的操作系统的一次性设置脚本 。

设置脚本处理一切:系统依赖性,Python环境,以及直接从我们的GitHub发行中下载必要的模型和工具(~4GB),以达到最高速度.

适用于 Linux、macOS 和 Windows（可选择排除语言）

为了节省磁盘空间和带宽，您可以在安装过程中排除特定的语言模型（de，en）或所有可选模型（all）。核心组件（LanguageTool，lid.176）始终包含。

在项目的根目录中打开终端，并运行适合你系统的脚本：

# 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"

QQ 用于窗口 以管理员权限运行设置脚本 。

** 安装一个读取并运行的工具,例如:CopyQ或AutoHotkey v2**. 此为出字观者所取.

安装是完全自动化的,在使用2个型号的新型系统时需要约8-10分钟.

  1. 导航到 setup 文件夹.

  2. 双击QQINLINECODE1X**.

      • 脚本将自动提示管理员权限 。 *

    • *它安装了核心系统,语言模型,AutoHotkey v2和CopyQ.

  3. 一旦安装完成,Aura Dictation将自动发射.

** 说明:** 您无需事先安装 Python 或 Git ; 剧本处理一切.

高级 / 自定义安装

如果您不想安装客户端工具（AHK/CopyQ）或想通过排除特定语言来节省磁盘空间，您可以通过命令行运行核心脚本：

# 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"
使用

使用方法

1. 启动服务

在 Linux 和 macOS 上

一个脚本处理所有事情。它会自动在后台启动主要的听写服务和文件监视器。

# Run this from the project's root directory
./scripts/restart_venv_and_run-server.sh

在 Windows 上

启动服务是一个两步手动过程：

  1. 启动主服务： 运行 start_aura.bat. 或从 .venv 使用 python3 启动服务

2. 配置你的快捷键

要触发听写，您需要一个可以创建特定文件的全局快捷键。我们强烈推荐跨平台工具 CopyQ。

我们的推荐：CopyQ

在 CopyQ 中创建一个带有全局快捷键的新命令。

Linux/macOS 的命令：

touch /tmp/sl5_record.trigger

在使用 CopyQ 时的 Windows 命令：

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()
    );
}

在使用 AutoHotkey 时的 Windows 命令：

; trigger-hotkeys.ahk
; AutoHotkey v2 script
#SingleInstance Force ; Ensures only one instance of the script runs

;===================================================================
; Hotkey to trigger Aura
; Press Ctrl + Alt + T to write the trigger file.
;===================================================================
f9::
f10::
f11::
{
    local TriggerFile := "c:\tmp\sl5_record.trigger"
    FileAppend("t", TriggerFile)
    ToolTip("Aura Trigger activated!")
    SetTimer(() => ToolTip(), -1500)
}

3 开始指挥! 点击任意文本字段, 按下您的热键, 将会出现“ 听… ” 通知 。 说清楚,然后暂停。 将为您输入更正文本 。

高级配置( 可选)

□ 高级配置( 可选)

您可以通过创建本地设置文件来定制应用程序的行为 。

  1. 导航到 config/ 目录.

  2. 创建config/settings_local.py_Example.txt并重命名为config/settings_local.py.

  3. 编辑 config/settings_local.py(它覆盖了主config/settings.py文件中的任何设置).

这个config/settings_local.py文件默认被Git忽略了,因此您的个人更改不会被更新所覆盖.

插件结构和逻辑

该系统的模块化通过插件/指令允许强大的扩展.

处理引擎严格遵守 ** 等级优先级链 ***:

  1. ** 模块装入顺序(高度优先):** 从核心语言包(de-DE, en-US)中加载的规则优先于从插件/目录中加载的规则(上个字母加载).

  2. ** 在文件顺序(Micro优先级):** 在任何给定的地图文件中(FUZZY MAP pre.py),规则严格由行号(从上到下)处理.

这种架构确保了核心系统规则得到保护,而项目特定规则或上下文意识规则(如用于CodeIgniter或游戏控制的规则)可以通过插件作为低优先级扩展而容易被添加.

Windows 用户的密钥脚本

Windows 用户的密钥脚本

以下是一个Windows系统设置,更新,运行应用程序的最重要脚本列表.

QQ 设置和更新

  • chmod +x update.sh; ./update.sh

  • setup/setup.bat:为首次一次性设置环境的主要剧本.

  • or Run powershell -Command "Set-ExecutionPolicy -ExecutionPolicy Bypass -Scope Process -Force; .\setup\windows11_setup.ps1"

  • update.bat:从项目文件夹运行到获得最新的代码和依赖.

QQ 运行应用程序

  • start_aura.bat:一个主脚本来启动口语服务.

& 帮助脚本

  • aura_engine.py:核心Python服务(通常由上面的脚本之一开始).

  • get_suggestions.py:用于特定功能的辅助脚本.

关键特性和操作系统兼容性

OS 兼容性图例

OS兼容性图例 :

  • *Linux(例如:Arch,Ubuntu)

    • 窗户 *

  • Android(用于移动特性)

** Core Speech-to-Text(奥拉)引擎* 我们的主引擎 离线语音识别和音频处理。

奥拉核心

** 奥拉-科雷** 🐧 🍏 🪟
├─ aura_engine.py (主平通服务管弦乐于奥拉) 🐧 🍏 🪟
├┬ ** Live Hot-Reload** (配置和地图) 🐧 🍏 🪟
│├ ** 安全私人地图加载(完整性-第一)** 🔒 🐧 🍏 🪟
││ * ** 工作流量:** 装入密码保护的 ZIP 档案 。
│├ ** 文本处理和校正/** 按语言分组(如de-DE,en-US,.
│├ 1. normalize_punctuation.py (标准标注后标注) 🐧 🍏 🪟
│├ 2. 智能预校(FuzzyMap Pre - The Primary Command Layer). 🐧 🍏 🪟
││ * ** Dynamic 脚本执行:规则可以触发自定义的Python脚本(on_match_exec)来进行高级动作,如API呼叫,文件一/O,或生成动态响应.
││ * ** 处决:** 规则按顺序处理,其效果为累积。 后来的规则适用于被更早的规则所修改的文本.
││ * ** 最高优先级停止标准:** 如果一项规则实现了** 完全匹配** (^…美元),则该令牌的整个处理管道立即停止。 这一机制对于执行可靠的语音指令至关重要。
│├ 3. correct_text_by_languagetool.py(用于语法/风格校正的集成语言工具) 🐧 🍏 🪟
│├ 4. 等级化 RegEx 规则引擎,带有 Ollama AI Fallback * 🐧 🍏 🪟
││ * ** 决定控制: 用于精确、高优先级命令和文本控制。
│├ * Vector-Search 插件**( Lazy 装载): 通过连接本地向量嵌入到 Ollama/ LLM 倒置层来启用语义搜索 🐧
││ * ** Ollama AI(当地LLM)倒计时:** 充当创造性答案的可选,低优先级的检查,QQA,以及高级的”模糊匹配”,当没有达到决定性规则时.
││ * ** 现状:** 地方LLM一体化。 │└ 5. ** 智能后校正** (FuzzyMap) * LT后校正 * 🐧 🍏 🪟
││ * 语言工具后用于校正 LT 特定输出. 遵循与前修正层相同的严格串联优先级逻辑.
││ * * Dynamic 脚本执行:规则可以触发自定义的Python脚本(on_match_exec)来进行高级动作,如API呼叫,文件一/O,或生成动态响应.
││ * ** Fuzzy 退后:** ** Fuzzy 相似度检查**(由阈值控制,例如85%)作为最低优先级错误校正层。 只有在前作的确定/分类规则运行失败(当前规则匹配是虚假的)时才执行,尽可能避免缓慢的模糊检查来优化性能.
├┬ ** 模式管理/**
│├─ prioritize_model.py (根据使用情况优化模型装载/卸载) 🐧 🍏 🪟
│└─ setup_initial_model.py (设想首次模式设置) 🐧 🍏 🪟
├─ ** 辅助 VAD 超时 * 🐧 🍏 🪟
├─ ** 自动热键(启动/停止)** 🐧 🍏 🪟
├─ ** 即时语言切换** (通过模型预装实验) 🐧 🍏
├─ ** 空管** (基于DAG的工作流程自动化) 🐧 🍏 🪟 │ 需要多克 ^ UI: http://localhost:8081 🐧 🍏 🪟
├─ ** 特里诺州发动机**(每次演讲/文字/网络的界面意识配置) 🐧 🍏 🪟 └─ 需要多克 ・ 管理 UI: http://localhost:8084 🐧 🍏 🪟

** 系统/**
├┬ ** 语言工具服务器管理/**
│├─ start_languagetool_server.py(启动本地语言工具服务器) 🐧 🍏 🪟
│└─ stop_languagetool_server.py(关闭语言工具服务器) 🐧 🍏 ├─ monitor_mic.sh(例如,不使用键盘和监视器而使用耳机) 🐧 🍏 🪟

** 模块和软件包管理*
强力处理大语言模型的工具.

** 管理模式/** 🐧 🍏 🪟
├─ * Robust 模型下载器** (GitHub 释放块) 🐧 🍏 🪟
├─ split_and_hash.py(Repo所有者可以分割大文件并生成校验和) 🐧 🍏 🪟
└─ download_all_packages.py(供最终用户下载、核实和重新组合多部分文件使用的工具) 🐧 🍏 🪟

发展和部署援助人员

** 发展和部署帮助者 *
用于环境设置,测试,以及服务执行的脚本.

  • Tip: glogg 使您能够使用正则表达式搜索日志文件中的有趣事件。 *
    请在安装与日志文件关联时检查复选框 。
    https://glogg.bonnefon.org/ (中文(简体) ).

Tip: 在定义了您的 regex 模式后, 运行 python3 tools/map_tagger.py 以自动生成 CLI 工具的可搜索示例 。 详情见Map Maintenance Tools。 *

然后再双击 log/aura_engine.log

** 帮助者/**
├┬ ** 虚拟环境管理/**
│├ scripts/restart_venv_and_run-server.sh (Linux/macOS) (英语). 🐧 🍏
│└ scripts/restart_venv_and_run-server.ahk(窗户) 🪟
├┬ ** 全系统语法融合/*
│├ Vosk 系统收听器集成 🐧 🍏 🪟
│├ scripts/monitor_mic.sh(Linux特定麦克风监测) 🐧
│└ scripts/type_watcher.ahk (AutoHotkey为识别文本收听并排出全系统) 🪟
└─ ** CI/CD 自动化/**
└─ 已扩展的 GitHub 工作流程( 安装、 测试、 文件部署) * * ( GitHub 动作运行) *

实验特征

  • 即将到来/实验特征 *
    目前正在开发或处于起草状态。

** 实验特征/**
├─ ** 分配后 REGE======================================================================================================================================================================================================================================================== 🐧
├┬插件
│** 《懒惰生活》** () 🐧 🍏 🪟
( 更换插件激活/停用及其配置,在下一次处理中应用,而不重新启动服务。 )
│ ├ ** git 命令 * (发送 git 命令的声音控制) 🐧 🍏 🪟
│ ├ ** Wannweil*(德国-Wannweil地点地图) 🐧 🍏 🪟
│ ├ ** 扑克插件(草案)(扑克应用程序的声音控制) 🐧 🍏 🪟
│ └ 0 公元插件(草案)(公元0游戏的声音控制) 🐧
├─ ** 开始或结束会话时声音输出 (描述待定) 🐧
├─ ** 视觉障碍的语音输出** (描述待定) 🐧 🍏 🪟
└─ SL5 Aura Android 原型*(尚未完全下线) 📱

*(注:Arch(ARL)或Ubuntu(UBT)等特定的Linux分布被一般Linux QQ符号所覆盖. 安装指南中可以包括详细的区分。

单击可查看用于生成此脚本列表的命令 
{ 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"; }
架构的图形概述

该架构的图形概述:

yappi_call_graph

pydeps -v -o dependencies.svg scripts/py/func/main.py

使用过的模型

使用的模型：

推荐：使用 Mirror 的模型 https://github.com/sl5net/SL5-aura-service/releases/tag/v0.2.0.1（可能更快）

这些压缩的模型必须保存到 models/ 文件夹中

mv vosk-model-*.zip models/

型号

尺寸

误字率/速度

笔记

许可证

vosk-model-en-us-0.22

1.8G

5.69（librispeech 测试清理）
6.05（tedlium）
29.78（呼叫中心）

精准通用美式英语模型

阿帕奇2.0

vosk-model-de-0.21

1.9G

9.83（Tuda-de 测试）
24.00（播客）
12.82（cv 测试）
12.42（mls）
33.26（mtedx）

德国大型电话和服务器模型

阿帕奇2.0

本表概述了不同的 Vosk 模型，包括它们的大小、词错误率或速度、备注以及许可信息。

LanguageTool 许可: GNU Lesser General Public License (LGPL) v2.1 or later

支持该项目

如果你觉得这个工具有用，请考虑请我们喝咖啡！你的支持有助于推动未来的改进。

ko-fi

Stripe-Buy Now