/quikey

A keyboard macro tool.

Primary LanguagePythonMIT LicenseMIT

Quikey PyPI version

A keyboard macro tool.

Please share your use case here!

Installation and Upgrade

The following packages will install two commands:

  • qk
  • quikey-daemon

Everything can be managed using just qk and examples are further below.

Python 3

$ pip3 install --user quikey 
$ pip3 install --user -U quikey #<-- Upgrade

or

$ python3 -m pip install --user quikey
$ python3 -m pip install --user -U quikey #<-- Upgrade

Arch Linux (AUR)

$ curl -L -O https://aur.archlinux.org/cgit/aur.git/snapshot/quikey.tar.gz && tar -xvf quikey.tar.gz && cd quikey && makepkg -si

Fedora (Copr)

$ dnf copr enable bostrt/quikey # Enable repo
$ dnf install quikey            # Install pkg
$ dnf update quikey             # Update pkg

Ubuntu, Debian, MXLinux, Mint, etc (PPA)

coming soon

Want to help with packaging?

Usage

Managing the daemon

There is a daemon process that must be running for Quikey's macro functionality to run. You can manage the daemon from the qk client:

Start daemon

$ qk start

Autostart on Login

$ qk autostart enable

Stop daemon

$ qk stop

Managing phrase entries

Adding a new phrase

$ qk add -n ':hello:' -p 'Hello, my name is John Doe.'

The -p flag is optional. If it is not included, your default editor ($EDITOR) will be used.

Listing all phrases

$ qk ls 
+---------+------+----------------------------+-----------------------------+
| Name    | Tags | Last Modified              | Phrase                      |
+---------+------+----------------------------+-----------------------------+
| :hello: |      | 2019-02-24T05:21:48.245440 | Hello, my name is John Doe. |
+---------+------+----------------------------+-----------------------------+

Interactive editing

Use interactive menus to edit and remove phrases:

$ qk edit
$ qk rm

Editing a phrase

$ qk edit -n ':hello:'

This will drop into your default editor ($EDITOR) with the current phrase for the given name.

Removing a phrase

$ qk rm -n ':hello:'
quikey phrase with key of :hello: has been deleted.

Development

See DEVELOP.md for help.