Runfile - If Rake and Docopt had a baby

An easy way to create project specific command line utilities

Wait, What?

Runfile lets you create command line applications in a way similar to Rake, but with the full power of Docopt command line options.

You create a Runfile, and execute commands with run command arguments -and --flags.

Install

$ gem install runfile

Example

The most minimal Runfile looks like this:

usage  "greet <name>"
action :greet do |args|
puts "Hello #{args['<name>']}" 
end

You can then run it by executing this command:

$ run greet Luke
Hello Luke

Executing run without parameters, will show the usage patterns:

$ run
Usage:
  run greet <name>
  run (-h | --help | --version)

Executing run --help will show the full help document (docopt)

$ run --help
Runfile 0.0.0

Usage:
  run greet <name>
  run (-h | --help | --version)

Options:
  -h --help
      Show this screen

  --version
      Show version

Documentation

• Learn by Example
• Runfile Command Reference
• More about Runfile

Test

$ rake test

Todo

• Add documentation for *.runfile form files
• (Colsole) Add newline detection in wordwrap (i.e. add indentation spaces after newline)
• Consider supporting user and system level *.runfiles
• Wiki (in progress)
• GitHub pages
• Can we have a colored docopt? Would be nice... (working, but causing some issues, will probably abandon)