Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
a simple hierachical command line shell
Ruby
tree: 24d481ec09

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
.gitignore
README.md
Rakefile
VERSION
menutree.gemspec

README.md

Menutree

Menutree is a framework for presenting a recursive menu shell on the command line, inspired by the CLI found in Cisco IOS and other similar products. Menutree lets users issue commands via an interactive nested shell interface, and also directly from the command line.

The menu structure and commands therein are defined by a directory of ruby scripts conforming to a simple interface. Inline help, command completion, and readline support are all built in.

Example:

Given a hypothetical program 'ticker' that uses the Menutree gem to manage a list of tickets, a sample interaction might look like:

$ ticker
> init
Ticker created an empty ticket database
> add "Do a little dance"
Ticket "Do a little dance" added as ticket 213
> rm
rm> 213
Ticket 213 ("Do a little dance") removed
rm> ..
> exit

Commands could also be run from the shell:

$ ticker add "Make a little love"
Ticket "Make a little love" added as ticket 214

To implement this, ticker would provide Menutree with a directory that looked like:

commands/
    init.rb
    add/
        default.rb
    rm/
        default.rb
Something went wrong with that request. Please try again.