~fancycade/nrg

ref: f60473074206f5bf1b9fb632f8dcdc915fee220b nrg/README.md -rw-r--r-- 1.0 KiB
f6047307 — fancycade Document format 1 year, 8 months ago

#nrg

Juice up your Crystal dev flow with a shot of nrg!!!

Simple script runner tool (like Make) for Crystal projects.

Make commands as keys in your shard.yml file.

Then execute them as commands with the nrg tool and feel that Crystal energy vibrating through you!

#Build

make dev

or

make prod

#Usage

Blog post

Install nrg onto your system.

sudo make install

Add keys in the script field in your project's shard.yml file.

script:
 dev:
   crystal build app.cr

Then run that command while in the project directory:

nrg dev

It simply executes system commands listed in the key.

Multiline commands work too. Make sure to add | at the end of the key name.

scripts:
 prod: |
   crystal build --release app.cr
   echo "Built prod"

#Format

Since formatting is a common thing, I've added a special command for formatting as shorthand for (crystal tool format):

nrg format