open.source/espanso
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Cross-platform Text Expander written in Rust
178 Commits 5 Branches 44 Tags 46 MiB
Rust 54.5%
C++ 42.6%
C 1.2%
Objective-C++ 1.2%
Shell 0.2%
6fa2204aa8
Go to file
Federico Terzi 6fa2204aa8 Fix #42
2019-09-27 23:06:52 +02:00
ci Fix Homebrew on CI 2019-09-21 19:15:10 +02:00
images Add windows installation instructions 2019-09-18 10:59:29 +02:00
native Fix clipboard backend on urxvt terminal 2019-09-22 16:43:58 +02:00
other/EspansoNotifyHelper Add GPL preamble 2019-09-15 18:29:11 +02:00
packager Add automatic deploy to Homebrew on CI 2019-09-21 18:59:29 +02:00
src Fix #42 2019-09-27 23:06:52 +02:00
.gitignore Ignore github pages output 2019-09-22 15:05:57 +02:00
azure-pipelines.yml Add automatic deploy to Homebrew on CI 2019-09-21 18:59:29 +02:00
build.rs Fix #30 2019-09-16 11:02:40 +02:00
Cargo.lock Add git cloning 2019-09-26 10:58:24 +02:00
Cargo.toml Add git cloning 2019-09-26 10:58:24 +02:00
LICENSE Initial commit 2019-08-30 09:16:58 +02:00
packager.py Add experimental CI Pipelines for Mac and Windows 2019-09-21 13:09:24 +02:00
README.md Test CI should fail 2019-09-21 18:21:26 +02:00

README.md

espanso

A cross-platform Text Expander written in Rust

Language Platforms License Build Status

example

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:

  • Save a lot of typing, expanding common sentences.
  • Create system-wide code snippets.
  • Execute custom scripts
  • Use emojis like a pro.

Key Features

  • Works on Windows, macOS and Linux
  • Works with almost any program
  • Works with Emojis 😄
  • Date expansion support
  • Custom scripts support
  • Shell commands support
  • App-specific configurations
  • File based configuration

Table of contents

Installation

Windows

The installation on Windows is pretty straightforward, navigate to the Release page and download the latest installer ( usually named like espanso-win-0.1.0.exe ).

Because espanso is not digitally signed, you may experience a warning from Windows Smartscreen. In this case, just click on "More info" (1) and then on "Run anyway" (2), as shown in the picture:

Windows Smartscreen

If you completed the installation procedure, you should have espanso running. A good way to find out is by going on any text field and typing :espanso. You should see "Hi there!" appear.

Linux

TODO

MacOS

The easiest way to install espanso on macOS using the Homebrew package manager, but you can also do it manually.

Using Homebrew

The first thing to do is to add the official espanso tap to Homebrew with the following command:

brew tap federico-terzi/espanso

Then you can install espanso with:

brew install espanso

To make sure that espanso was correctly installed, you can open a terminal and type:

espanso --version

At this point, you have to Enable Accessibility to use espanso.

Enabling Accessibility

Because espanso uses the macOS Accessibility API to work, you need to authorize it using the following procedure:

Open a terminal and type the command:

espanso install

A dialog should show up, click on "Open System Preferences", as shown here:

Accessibility Prompt

Then, in the "Privacy" panel click on the Lock icon (1) to enable edits and then check "espanso" (2), as shown in the picture:

Accessibility Settings

Now open the terminal again and type:

espanso install

If everything goes well, you should see the espanso icon appear in the status bar:

macOS status bar icon

If you now type :espanso in any text field, you should see "Hi there!" appear!

Usage

TODO

FAQ

How does espanso work?

TODO

Donations

espanso is a free, open source software developed in my (little) spare time. If you liked the project and would like to support further development, please consider making a small donation, it really helps :)

Donate with PayPal

License

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