Yumon

The minimalist task CLI executor.

Table of content

• Install
• Usage
  • Init command
  • Select command
    • Custom config
  • Help
• Example config

Install

Global:

$ npm i -g yumon

Or locally:

$ npm i -D yumon

Usage

Yumon will always look for a yumonrc.yaml file (by default) in the directory where it is run:

Init

To initialize a default configuration file run the following command:

$ yumon init

Select

To select a task and execute it use the following command:

$ yumon select

Or for quick access simply:

$ yumon

Custom config

If your configuration file is located in another location, use the following option:

$ yumon --config path/to/config.yaml

Help

For help on all other commands run:

$ yumon --help

Example config

tasks:
  - name: Hello world
    alias:
      - greet
    description: Show a "Hello world"
    action: echo "Hello world"

License

This project is under the MIT license.