Contents

# Commando

A command line interface builder with Readline support

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'commando'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install commando

## Configuration

You can configure the start up greeting, the command line prompt, and the set
of available commands to use.

```ruby
Commando.configure do |config|
  config.greeting = 'Welcome to my CLI. Type "help" for a list of commands'
  config.prompt = 'my-app> '

  config.register 'addfriend', MyApp::AddFriend, 'Adds a friend to your network'
end
```

### Actions

To support a new command, you must register it with the command the user will
type (e.g. `help`), a class/module/instance that responds to `#perform(args, output:)`,
where `args` is an `Array<String>` of the extra words the follow the command
(e.g. if the user types `addfriend mary jane`, then the args are `['mary', 'jane']`)
and `output` is the `IO` instance that any messages should be written to. By
default `IO` is `$stdout`

A few default actions have been registered

* help - Prints a help message, including a list of commands
* history - Prints the history of commands entered so far
* quit - Exits the program

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/commando. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.


## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
tcollier-commando-0.1.0	README.md