neph

This README is the one indexed from the repository at its latest ref, not from the tag for this version.

• A modern command line job processor written in Crystal :rocket:
• Parallel job execution. :rocket:
• Use like make command. :rocket:

Installation

Arch Linux

Use your favourite AUR helper.
Package name: neph-git

Mac

You can install Neph with brew.

$ brew tap tbrand/homebrew-neph
$ brew install neph

Manual

Build dependencies:

• crystal and shards for building the binary
• go-md2man for generating the man page

It needs libyaml to be installed.

If you have a previous version of neph installed:

$ git clone https://github.com/tbrand/neph
$ cd neph
$ neph           # man page will be at neph.1, binary will be at bin/neph

If you don't have a previous version of neph installed:

$ git clone https://github.com/tbrand/neph
$ cd neph
$ shards build    # Now executable binary is located at bin/neph
$ bin/neph man    # Generate man page. It will be located at neph.1

Usage

All features for neph.yaml is written in sample/neph.yaml. So please refer for the details.

Wiki is also maintained as a document. Here is a full features.

• Execute command from neph
• Define dependencies between jobs
• Working directory
• Specify sources
• Ignoring errors
• Hide executing command
• Set a job result to env vars
• Import other configurations
• Command line options
• Log locations
• Log modes

Use cases

Neph is used in which_is_the_fastest.
The build time is reduced from 102[sec] to 33[sec].
The neph.yaml is here.

Contributing

1. Fork it ( https://github.com/tbrand/neph/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Contributors

• tbrand Taichiro Suzuki - creator, maintainer
• notramo Márton Szabó - maintainer