Skip to content

README.md

Latest commit

 

History

History
39 lines (35 loc) · 2.04 KB

README.md

File metadata and controls

39 lines (35 loc) · 2.04 KB

Lusk is a modular, plugin-based project manager. It is simple, based on a human-readable document format called YAML. It has a built-in plugin manager to add, remove or configure plugins. You can use Lusk to automate your build procedures, create templates and more. It is based on Transit Plugin Architecture Version 1, absolutely extended beyond it's definitions.

Installation

You need Node.JS v20 or later. You can run the command below to install Lusk:

npm install -g lusk

Usage

To see the built-in help page, please run the command below:

lusk help

After checking in the help page, go to the project that you want to use lusk and test it. Here's an example preset document (lusk.yaml) for you to test:

default:
    action: os.shell
    cmdlines:
        - echo Hello World

After writing this to a file, Execute the preset by running this in the command line:

lusk make

and you should see a Hello World message.

Beyond the boundaries

To see more details, please visit https://github.com/luskproject/lusk/wiki