Configuration

Following a Unix-like philosophy, espanso uses files to manage it’s configuration instead of GUIs. This has many advantages, such as the capability to easily sync your configurations between machines using Git or cloud services such as Dropbox or Google Drive.

Structure

All espanso configurations reside in a folder called espanso, whose location varies between Operating Systems:

  • Linux: $XDG_CONFIG_HOME/espanso (e.g. /home/user/.config/espanso)
  • macOS: $HOME/Library/Preferences/espanso (e.g. /Users/user/Library/Preferences/espanso)
  • Windows: {FOLDERID_RoamingAppData}\espanso (e.g. C:\Users\user\AppData\Roaming\espanso)

A quick way to find the path of your configuration folder is by using the following command:

espanso path

The espanso directory will contain the following file structure:

- default.yml
- user/

The default.yml file contains the main configurations and for a basic usage, this is the only file you will be working with. You can find a list of all the possible options in the Options section.

The user folder is used to store more advanced user configurations, such as Application-specific configs.

Migrating from versions prior to v0.3.0

Prior to version v0.3.0, espanso located all configurations in the user home directory, into the .espanso folder. This location is now deprecated and, while being still supported for compatibility purposes, you should migrate to the new one with the following steps:

  • Copy the default.yml and the user/ directory in the new espanso config folder ( you can find the new config location with the espanso path command ).
  • Copy the contents of the packages folder into the new packages path ( you can find the new package location with the espanso path command ).

Application-Specific Configurations

Sometimes you may need to make espanso behave differently with some applications. For example, you may want to have a different set of Matches for an application, or you may need to change the backend option for compatibility purposes.

For such cases, espanso offers the Application Specific configurations, that is configurations that are valid only for some applications which match specific filters.

Let’s say you want to add some Matches for emojis, but only when using the Telegram desktop app.

You can create a telegram.yml file in the espanso/user folder, with the following content:

filter_title: "Telegram"

matches:
  - trigger: ":ok"
    replace: "👍"

After restarting espanso with espanso restart, you are ready to test the new configuration.

Navigate to Telegram and type :ok, you should see your emoji appear. If you then move to another application and try again, you should not see it!

The key here is the filter_title option, that basically means: “If the current application contains Telegram in the title, use this configuration instead of the default.yml one”

Note: app-specific configurations don’t support all options, refer to the table below to find out more.

Available Filters

espanso supports various filters, but their support depends on the Operating System used. You can refer to this table:

Filter Description Windows Support MacOS Support Linux Support
filter_title Filter based on the current Window title Full support Uses the App identifier instead of the Window title Full support
filter_exec Filter based on the current application executable path Full support Full support Partial support
filter_class Filter based on the current Window class Uses the application executable path instead Uses the App identifier instead Full support

The filter_title, filter_exec and filter_class filters support a full regex as parameter.

Finding the right filters

To make it easier to find the right filters, espanso offers the detect subcommand. Open a terminal and type:

espanso detect

Now, while leaving it running, move to the desired application and then come back to the terminal. You should see an output like:

Detected change, current window has properties:
==> Title: 'Telegram (1828)'
==> Class: 'TelegramDesktop'
==> Executable: '/snap/telegram-desktop/953/bin/Telegram'

These are the parameters espanso detected for your target application, so you can now use them to create the perfect filter.

Options

Here’s a list of all options available for the configuration file:

Option Description Possible Values Default App-Specific
backend The typing engine used. Inject simulate keypresses, Clipboard simulates a copy/paste Clipboard or Inject Inject on Win and macOS, Clipboard on Linux Yes
backspace_limit How many backspace espanso tracks to correct misspelled keywords int 3 No
disabled Set the current configuration as disabled True/False False Yes
parent The target for the current configuration file, mainly used in packages string self Yes
ipc_server_port Windows only. Set the daemon listening port int 34982 No
exclude_default_matches Used in app-specific configs, avoid parent matches True/False False Yes