espanso README

The project's README from github.com/espanso/espanso. As one markdown file: README.md.

Espanso Logo Espanso Logo

A cross-platform Text Expander written in Rust

GitHub release (latest by date) Maintenance Language inspect.software License

Platforms

Ask DeepWiki

Example: 2019 Example: 2025
example example2025

What is a Text Expander?

A text expander is a program that detects when you type a specific keyword and replaces it with something else. This is useful in many ways:

Key Features

Community & Support

Quick Start Examples

You can create additional files to organize your matches any way you want.
Make sure to adhere to proper YAML spacing.

matches:
  - trigger: ":hello"
    replace: "Hi There!"
  - triggers: [":test1", ":test2"]
    replace: "These both expand to the same thing"

Team Members and Contributors

Team

Federico Terzi (Creator of espanso)
Rest of team in Alphabetical Order
Archigos (Maintainer)
Auca (Lead Maintainer)
n8henrie
smeech

You can also see the up to date list of Team Members here

Contributors

So many people have helped the project along the way. Thank you all!

Image

Sponsors

We want to thank SignPath.io for code signing the Windows binaries ❤️

Donations

espanso is a free, open-source software project created by Federico Terzi and now maintained by a small team.
If you liked the project and would like to support further development, please consider making a small donation, it really helps :)

Current Options

PayPal Coming Soon
Donate with PayPal

Remarks

License

espanso was created by Federico Terzi and is licensed under the GPL-3.0 license.

espanso (espanso/espanso)

Searching Database…

14.6K ·GitHub
What is this?Espanso is a cross-platform text expander written in Rust that detects a keyword you type and instantly replaces it with something else, like a snippet, date, or script output.
Is this an app running in the background or something I open manually?It is a background desktop app that watches your keystrokes system-wide and triggers expansions in whatever program you're typing into, rather than something you open and use directly.
How do I start using it and define my own expansions?After installing, you define matches (trigger keywords and their replacements) in YAML files; you can split them into multiple files to organize things however you like.
Does it need extra libraries on Linux to work?On Linux it relies on libxdo and xclip, plus libxkbcommon and wl-clipboard for the experimental Wayland port.
Is Wayland support fully ready?Wayland support is labeled experimental, so it may not be as stable or complete as the X11/Windows/macOS implementations.
Does espanso send my typed text anywhere?No, espanso is privacy-first: everything runs 100% locally on your machine with no tracking.
What can I expand besides plain text snippets?Espanso supports emojis, images, date expansion, custom scripts, shell command output, and even interactive forms as expansion content.
Can I get ready-made snippet packs instead of writing my own?Yes, espanso includes a built-in package manager and integrates with espanso hub, letting you install community-made expansion packages directly.
Does it support regex-based triggers or app-specific behavior?Yes, espanso supports regex triggers for matches and lets you configure app-specific settings so expansions can behave differently per application.
Is there a GUI for searching or managing matches?Espanso includes a built-in search bar for quickly finding and inserting matches without memorizing every trigger keyword.
Creator
espanso
Size
102.1 MB
Stars
14.6K
Age
7y
Commits · 90 Days