Skip to content

Latest commit

 

History

History
88 lines (57 loc) · 2.48 KB

README.md

File metadata and controls

88 lines (57 loc) · 2.48 KB

Build Status Join the chat at https://gitter.im/kcmerrill/alfred Open Source Helpers

Alfred

Even Batman needs a little help.

alfred

A simple go/yaml powered make file/task runner with a bit of a twist and a ton of flexibility.

Features

  • Extendable + Plugins
  • Watch files for modifications
  • Retry/Rerun tasks based on failures before giving up
  • Logging
  • Success/Failure decision tree
  • Run tasks asynchronously or synchronously
  • Arguments
  • Loops
  • Static webserver
  • Many more!

For more information RTFM.

Sample Usage

Create a file named: alfred.yml

say.hello:
    summary: I will say hello!
    usage: alfred say.hello
    command: echo "Hello!"

say.howareyou:
    summary: I will ask how you are
    usage: alfred say.howareyou
    command: |
        echo "How"
        echo "Are"
        echo "You?"

speak:
    tasks: say.hello say.howareyou

blurt:
    multitask: say.hello say.howareyou

Then, anywhere in the top-level or child directories to the alfred.yml file:

alfred Will show you all of the available tasks and a quick summary.

alfred say.hello Will simply say hello

alfred say.howareyou Will ask how you are

alfred speak will perform both tasks in the specified order

alfred blurt will perform both tasks at the same time

Screencast/Demo

asciicast

Example uses

  • Monitor websites
  • Setup/Update/Deploy projects in your dev env
  • Simple Nagios, Jenkins, pingdom replacement
  • Monitor crons(alert on failures, update endpoints etc ... )
  • Watch for file modifications to run tests->builds

Binaries || Installation

MacOSX Linux

via go:

$ go get -u github.com/kcmerrill/alfred

via docker:

$ docker run -v $PWD:$PWD -w $PWD kcmerrill/alfred