Espanso match.yml

define WHAT Espanso does

Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/espanso-match-yml/latest.json
Source https://raw.githubusercontent.com/espanso/espanso/refs/heads/dev/schemas/match.schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

a schema to validate base.yaml

Properties

$schema string
imports string[]

Import other matches from external locations

anchors anchor[]
matches object[]

Array of matches

global_vars object[]

Definitions

match object

Single match

anchor string
comment string
force_clipboard boolean
force_mode string
Values: "clipboard" "keys"
form string
form_fields object
html string
image_path string
label string
left_word boolean

The related properties, left_word: true and right_word: true, ensure a match will only occur at the beginning or end of words respectively, and not in the middle.

markdown string
paragraph boolean

The paragraph: true option may be added to markdown replacements to avoid injecting a new-line and new paragraph.

propagate_case boolean
right_word boolean

The related properties, left_word: true and right_word: true, ensure a match will only occur at the beginning or end of words respectively, and not in the middle.

search_terms string[]
uppercase_style string
Values: "capitalize" "capitalize_words" "uppercase"
regex string
replace string | null
trigger string
triggers string[]
vars var[]
word boolean
var object | object | object | object | object | object | object | object | object
anchor string
form_field_definition object
form_multiline_field object
multiline boolean
default string
Default: ""
form_choice_or_list_field object
type string required
Values: "choice" "list"
values array | string required
default string
Default: ""
trim_string_values boolean

If you pass the values as a multiline string and this option is true, Espanso will trim the values and remove empty ones.

Default: false