Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
The complete solution for Ruby command-line executables
Ruby

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
lib
spec
History.txt
Manifest.txt
README.txt
Rakefile
commander.gemspec

README.txt

= commander
 
  Open source sub-command framework.

== DESCRIPTION:

  Commander is a small framework for creating a sub-command utility. 
  For example a sub command would be 'git add' or 'git rm', where 'add' and
  'rm' are sub commands.

== FEATURES:

  * Sub-commands
  * Auto-generated help documentation globally and per sub-command
  * Simple syntax and implementation
  * Extensible help generators for various output formats
  * Use the 'commander' command to initialize a commander driven program
  * Dependent on highline for terminal interaction (ask, choose, etc)
  
== USAGE:

  require 'commander'
  
  init_commander(
      :name => 'Commander', 
      :version => Commander::VERSION, 
      :description => 'Commander utility program.'
    )
  
  command :init do |c|
    c.syntax = 'commander init <filepath>'
    c.description = 'Initialize an empty file with a commander skeleton.'
    c.example 'Apply commander to a blank file.', 'commander init ./bin/my_executable'
    c.option('-r', '--recursive', 'Do something recursively') { puts "I am recursive." } 
    c.option('-v', '--verbose', 'Do something verbosely') { puts "I am verbose." } 
    c.when_called do |args|
       list = ask 'List some items:', Array
       # Do something with list
    end
  end

== KNOWN ISSUES:
  
  * none

== TODO:

  * do testing for these apps like highline does with mock IO
  * utilize highline for paging help documentation
  * look at highline examples and change commander commands to work without new-lines etc
  * more / better documentation
  * help generator options (such as large option description etc)
  * help generators should use erb
  * refactor

== LICENSE:

(The MIT License)

Copyright (c) 2008 FIX

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Something went wrong with that request. Please try again.