Espanso 教程：快速入门与配置指南

Espanso 教程：快速入门与配置指南

espansoCross-platform Text Expander written in Rust项目地址:https://gitcode.com/gh_mirrors/es/espanso

1. 项目目录结构及介绍

Espanso 是一个跨平台的文本扩展工具，其项目目录结构如下：

ESPANSO_HOME/
├── config/          # 存放核心配置文件
│   └── default.yml  # 默认配置文件
├── match/           # 包含自定义匹配项的包
│   ├── base.yml      # 基础匹配项文件
│   └── packages/     # 存放用户安装的扩展包
└── runtime/         # 运行时数据存储位置

• config/: 此目录包含 Espanso 的配置文件，default.yml是默认的核心配置。
• match/: 包含自定义文本替换规则的文件，base.yml存储基础的匹配项，packages/则用于存储下载的扩展包。
• runtime/: 用于存储运行时产生的数据，比如匹配项的历史记录。

2. 项目的启动文件介绍

Espanso 作为一个后台服务运行，通常不需要直接启动文件。而是通过系统托盘图标或命令行工具来管理和操作。在终端中，你可以使用以下命令启动 Espanso（确保已正确安装）：

espanso start

要停止 Espanso，可以执行：

espanso stop

若想查看 Espanso 的状态，可以运行：

espanso status

3. 项目的配置文件介绍

default.yml

default.yml是 Espanso 的核心配置文件，它定义了全局的行为。其中关键配置选项包括：

• auto_restart: 是否在配置文件更改后自动重启服务，默认为 false。
• pre_paste_delay: 替换前的延迟时间（单位为毫秒），默认值是 100ms，可用来控制替换速度。

例子：

auto_restart: false
pre_paste_delay: 100

自定义匹配项

匹配项定义在 match/base.yml 或者你自己创建的 .yml 文件中。它们遵循以下格式：

- trigger: "<your-trigger>"
  replace: "<replacement-text>"
  label: "<optional-label>"
  filter_class: "<application-class>"
  extra_includes: 
    - "<additional-matching-file>"

• trigger: 触发文本，当输入该字符串时会启动替换。
• replace: 替换后的文本，可以包含变量或其他复杂内容。
• label: （可选）给匹配项添加描述，方便在搜索框中区分。
• filter_class: （可选）限制匹配项在特定应用程序中生效。
• extra_includes: （可选）包含额外的匹配项文件。

举例来说，创建一个简单的匹配项，当输入 :hello 时替换为 你好世界：

- trigger: ":hello"
  replace: "你好世界"

动态匹配项： 动态匹配项允许使用变量和命令，例如：

- trigger: ":today"
  replace: "[[mytime]]"
  vars:
    - name: mytime
      type: date
      params:
        format: "%Y-%m-%d"

这里的 [[mytime]] 表示插入变量，mytime 类型为日期，格式化为 %Y-%m-%d。

完成配置后，保存文件并运行 espanso reload 来应用新的配置。

---

希望这篇教程能够帮助您更好地理解和使用 Espanso。更多信息可参考 Espanso 的官方文档： Espanso Docs。祝您使用愉快！

espansoCross-platform Text Expander written in Rust项目地址:https://gitcode.com/gh_mirrors/es/espanso