Skip to content
This repository has been archived by the owner on Mar 24, 2023. It is now read-only.
/ briefli Public archive

Linux text expander. Heavily inspired by breevy.

License

Notifications You must be signed in to change notification settings

liquidiert/briefli

Repository files navigation

briefli

Linux text expander. Heavily inspired by breevy and built from keylog source.

Installation

In order to work briefli needs the installation of redis first:

sudo apt update
sudo apt install redis

After installation set redis up (for configuration options see redis conf):

sudo nano /etc/redis/redis.conf
redis-server /etc/redis/redis.conf

Now you can download the latest release and copy the executable to a directory that is in your PATH or you can build from source:

# prerequesites
sudo apt update
sudo apt install libxdo-dev
git clone https://github.com/liquidiert/briefli.git
# install redis library
git clone https://github.com/redis/hiredis.git
cd hiredis
sudo ln -s /usr/local/include/hiredis/hiredis.h /usr/lib/gcc/x86_64-linux-gnu/9/include/ (or wherever your gcc dir is)
make
sudo make install
cd ../briefli
make
sudo make install

If you ever want to uninstall briefli just exec:

sudo make uninstall

Usage

As mentioned earlier briefli works with redis. That is so one can dynamically add / change / delete shortcuts. For general use of redis see redis commands.

Currently shortcuts can be 5 chars long max.

Adding a shortcut

redis-cli set <shortcut> <shortcut_value>

Changing a shortcut

redis-cli set <shortcut> <new_shortcut_value>

Removing a shortcut

redis-cli del <shortcut>

To start briefli just type briefli into your console and see your shortcuts come to life :D
brieflis' default behaviour is to trigger text replace after you pressed CTRL key.

Options

There a several options that allow you to tweak the behaviour of briefli.

For example you could add a systemd service and let it execute briefli -d and briefli will run for ever as a background service :D
For all ooptions see briefli -h

About

Linux text expander. Heavily inspired by breevy.

Resources

License

Stars

Watchers

Forks

Packages

No packages published