hiraishin's Introduction

Hiraishin

A simple gem that adds executable and library for adding shortcuts to programs. Check the rubygems link here

Name

This gem was named after Yondaime Hokage's main technique Flying Raijin Jutsu (or Hiraishin no Jutsu, in Rōmaji), which allows the user to instantaneously teleport themselves to a previously marked location. Similarly, this gem allow its user to create shortcuts and bind them to commands, allowing instant access.

Installing

Using rubygems:

gem install hiraishin

Usage

Command line utility usage example:

hiraishin -n browser -c /usr/bin/google-chrome -k Ctrl,Alt,Shift,c

Command line utility help:

Usage: hiraishin -n NAME -c path/to/command -k keys,to,be,pressed
    -n, --name=NAME                  Name of the shortcut
    -c, --command=COMMAND            Command to be executed
    -k, --keys=KEYS                  Keys to bind shortcut to
    -h, --help                       Prints this help

Using on a ruby program:

require 'hiraishin'


Hiraishin.add_shortcut_to_cinnamon 'browser', '/usr/bin/google-chrome', :Ctrl, :Alt, :Shift, :c

To do

add support to other GUIs (like MATE, GNOME etc)
add some tests

Contributing

Please feel free to open issues and suggest improvements or functionality to this gem.

hiraishin's People

Contributors

Watchers

hiraishin's Issues

Make easier to extend

The idea is to move the platform-specific code to modules/plugins so it's easier to extend and modularize as new platforms will be added.

Add Specs

Parent Issue #4

Specs strategy

It's not very straightforward to test if the behavior was correctly added to the system.
Ideas of the best ways to develop these tests are very welcome.