Runfile - command line for your projects
A beautiful command line application framework
Rake-inspired - Docopt inside
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
.
Quick Start
$ run new # create a new Runfile
$ run --help # show the usage patterns
$ vi Runfile # edit the 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
Breaking changes in 0.12.0
Note that version 0.12.0 removes several commands from the DSL.
If you were using any of the Colsole commands (say
, resay
, etc.), or any of
the run
, run_bg
commands, you will have to adjust your Runfile since they are
no longer available.
For convenience, you can simply require runfile/compatibility
at the top of
your Runfile, to still have this functionality included.
More info and alternative solutions in this pull request.
Contributing / Support
If you experience any issue, have a question or a suggestion, or if you wish to contribute, feel free to open an issue.