Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/derekstavis/touchrunner

Run npm scripts from the MacBook Pro Touch Bar
https://github.com/derekstavis/touchrunner

fishshell npm ohmyfish scripts touchbar

Last synced: about 2 months ago
JSON representation

Run npm scripts from the MacBook Pro Touch Bar

Awesome Lists containing this project

README

        

#### touchrunner
> Run tasks from the touchbar

[![MIT License](https://img.shields.io/badge/license-MIT-007EC7.svg?style=flat-square)](/LICENSE)
[![Fish Shell Version](https://img.shields.io/badge/fish-v2.2.0-007EC7.svg?style=flat-square)](https://fishshell.com)
[![Oh My Fish Framework](https://img.shields.io/badge/Oh%20My%20Fish-Framework-007EC7.svg?style=flat-square)](https://www.github.com/oh-my-fish/oh-my-fish)


## Installing

```fish
$ omf install touchrunner
```

## What will you get

![Touchrunner demo](touchrunner.gif "Touchrunner demo")

## Requirements

1. Have **Oh My Fish** installed. For more information, check [here](https://github.com/oh-my-fish/oh-my-fish#installation).
1. Be using **iTerm2**, for Touch Bar support.

## Usage

1. Edit the Touch Bar (View -> Customize Touch Bar) to have only "Function keys" block.
1. Enter a directory with a `package.json` and the tasks will appear at the touch bar.
1. Exitting the directory makes the Touch Bar be restored to function keys.

## Configuration

By default touchrunner will use `npm run`. If you want to switch the task
runner, you can override via `touchrunner_command` global variable, eg.:

```fish
set -g touchrunner_command yarn
```

# License

[MIT][mit] © [Derek Stavis][author]

[mit]: https://opensource.org/licenses/MIT
[author]: https://github.com/derekstavis
[omf-link]: https://www.github.com/oh-my-fish/oh-my-fish

[license-badge]: https://img.shields.io/badge/license-MIT-007EC7.svg?style=flat-square