Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bostrt/quikey
A keyboard macro tool.
https://github.com/bostrt/quikey
autohotkey autokey autokeyboard keyboard support-tools technical-support-engineering
Last synced: about 2 months ago
JSON representation
A keyboard macro tool.
- Host: GitHub
- URL: https://github.com/bostrt/quikey
- Owner: bostrt
- License: mit
- Created: 2017-12-24T03:54:12.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T19:28:29.000Z (almost 2 years ago)
- Last Synced: 2024-10-03T12:37:48.377Z (3 months ago)
- Topics: autohotkey, autokey, autokeyboard, keyboard, support-tools, technical-support-engineering
- Language: Python
- Homepage: https://blog.quikey.io
- Size: 62.5 KB
- Stars: 37
- Watchers: 9
- Forks: 3
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Quikey [](https://badge.fury.io/py/quikey)
A keyboard macro tool.
Please share *your* use case [here](https://github.com/bostrt/quikey/issues/54)!
----
* [Installation](#installation-and-upgrade)
* [Python 3](#python-3)
* [Arch Linux (AUR)](#arch-linux-aur)
* [Fedora (Copr)](#fedora-copr)
* [Ubuntu, Debian, MXLinux, Mint, etc](#ubuntu-debian-mxlinux-mint-etc-ppa)
* [Usage](#usage)
* [Managing the daemon](#managing-the-daemon)
* [Managing phrase entries](#managing-phrase-entries)
# 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](#usage).
## Python 3
```shell
$ pip3 install --user quikey
$ pip3 install --user -U quikey #<-- Upgrade
```
or
```shell
$ python3 -m pip install --user quikey
$ python3 -m pip install --user -U quikey #<-- Upgrade
```
## Arch Linux (AUR)
```shell
$ 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)
```shell
$ dnf copr enable bostrt/quikey # Enable repo
$ dnf install quikey # Install pkg
$ dnf update quikey # Update pkg
```
## Ubuntu, Debian, MXLinux, Mint, etc (PPA)
```shell
coming soon
```
[Want to help with packaging?](https://github.com/bostrt/quikey/issues/49)
# 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
```shell
$ qk start
```
### Autostart on Login
```shell
$ qk autostart enable
```
### Stop daemon
```shell
$ qk stop
```
## Managing phrase entries
### Adding a new phrase
```shell
$ 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
```shell
$ 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
```shell
$ qk edit -n ':hello:'
```
This will drop into your default editor (`$EDITOR`) with the current phrase for the given name.
### Removing a phrase
```shell
$ qk rm -n ':hello:'
quikey phrase with key of :hello: has been deleted.
```
## Development
See [DEVELOP.md](DEVELOP.md) for help.