LinuxCommandLibrary

espanso

Expand text snippets with keywords automatically

TLDR

Check status

$ espanso status
copy

Edit the configuration
$ espanso edit config
copy

Install a package from the hub store ()
$ espanso install [package]
copy

Restart (required after installing a package, useful in case of failure)
$ espanso restart
copy

SYNOPSIS

espanso {command}

PARAMETERS

start
    Starts the espanso daemon in the background.

stop
    Stops the espanso daemon.

restart
    Restarts the espanso daemon.

status
    Displays the current status of the espanso daemon.

configure
    Opens the configuration directory in your default file manager.

match
    Tests a match definition from the espanso configuration.
Example: espanso match :date

path
    Shows where the espanso configuration files are located.

install
    Installs espanso and sets up auto start.

uninstall
    Uninstalls espanso and removes the auto start setup.

version
    Prints the current version of espanso.

register
    Registers the application for auto-start.

unregister
    Unregisters the application from auto-start.

clean
    Cleans temporary files created by espanso.

DESCRIPTION

Espanso is a powerful and extensible text expansion tool written in Rust. It allows you to define abbreviations that are automatically replaced with longer pieces of text, snippets, or even execute shell commands.

It's designed to increase productivity by reducing repetitive typing and automating common tasks. Espanso works across all applications on your Linux system, making it a versatile tool for developers, writers, and anyone who wants to save time and effort. Configuration is done through YAML files, offering flexibility in defining triggers, replacements, and contextual behaviors. It includes features for date insertion, shell command execution, clipboard management, and package management via the espanso hub for easy customization.

It intelligently expands text based on the current context, and it can be configured to behave differently in various applications. It is customizable to fit user workflows.

CAVEATS

Espanso requires accessibility permissions to monitor keyboard input. Ensure that these permissions are granted for proper functioning.

CONFIGURATION FILES

Espanso's configuration is stored in YAML files. The main configuration file is typically located at `$HOME/.config/espanso/default.yml`. You can use the `espanso configure` command to open this directory in your file manager.

CONTEXT AWARENESS

Espanso supports context awareness, allowing you to define different expansions based on the currently active application. This is achieved by using the `app` field in your match definitions.

ESPANSO HUB

The Espanso Hub is a repository of community-contributed packages. You can install packages from the hub using the `espanso install ` command.

HISTORY

Espanso is actively developed and maintained. The project was created to provide a cross-platform text expansion tool with a focus on flexibility and ease of use. It has gained popularity due to its ability to automate various typing tasks and integrate seamlessly with different applications. The project utilizes Rust and features a package manager which allow users to contribute to a rich variety of text macros.

SEE ALSO

xclip(1), xsel(1)

Copied to clipboard