Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

A command line tool that helps you remembering ALL the numerous keyboard shortcuts of ALL your favorite programs.

Project description

keycut

logo

pipeline status coverage report documentation pypi version

A command line tool that helps you remembering ALL the numerous keyboard shortcuts of ALL your favorite programs.

KeyCut (for keyboard shortcut) is a command line tool that helps you remembering the numerous keyboard shortcuts of your favorite programs, both graphical and command line ones, by allowing you to print them quickly in a console and search through them.

Shortcut data are provided by the [keycut-data][1].

This repository contains the sources for a Python implementation of KeyCut.

How it looks

The yellow parts are the one that matched a pattern using a regular expression.

screenshot

Requirements

keycut requires Python 3.6 or above.

To install Python 3.6, I recommend using pyenv.
# install pyenv
git clone https://github.com/pyenv/pyenv ~/.pyenv

# setup pyenv (you should also put these three lines in .bashrc or similar)
export PATH="${HOME}/.pyenv/bin:${PATH}"
export PYENV_ROOT="${HOME}/.pyenv"
eval "$(pyenv init -)"

# install Python 3.6
pyenv install 3.6.8

# make it available globally
pyenv global system 3.6.8

Installation

With pip:

python3.6 -m pip install keycut

With pipx:

# install pipx with the recommended method
curl https://raw.githubusercontent.com/cs01/pipx/master/get-pipx.py | python3

pipx install --python python3.6 keycut

You will also need to download the data by cloning the repository somewhere:

git clone https://github.com/pawamoy/keycut-data ~/.keycut-data

Usage

The program needs to know where the data are. By default, it will search in the (relative) keycut-data/default directory.

export KEYCUT_DATA=~/.keycut-data/default

Show all bash shortcuts:

keycut bash

Show all bash shortcuts matching proc (in Category, Action, or Keys):

keycut bash proc

Command-line help:

usage: keycut [-h] APP [PATTERN]

Command description.

positional arguments:
  APP         The app to print shortcuts of.
  PATTERN     A regex pattern to search for.

optional arguments:
  -h, --help  show this help message and exit

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for keycut, version 0.3.0
Filename, size File type Python version Upload date Hashes
Filename, size keycut-0.3.0-py3-none-any.whl (22.2 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size keycut-0.3.0.tar.gz (8.5 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page