Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A higher level command-line oriented interface.

Merge pull request #134 from abinoam/issue_129_fix

Some fixes for Rubinius and dropping of 1.8 support
latest commit b5e48298b8
James Edward Gray II authored

README.rdoc

HighLine

by James Edward Gray II

Build Status

Description

Welcome to HighLine.

HighLine was designed to ease the tedious tasks of doing console input and output with low-level methods like gets() and puts(). HighLine provides a robust system for requesting data from a user, without needing to code all the error checking and validation rules and without needing to convert the typed Strings into what your program really needs. Just tell HighLine what you're after, and let it do all the work.

Documentation

See HighLine and HighLine::Question for documentation.

Start hacking in your code with HighLine with:

require 'highline/import'

Examples

Basic usage:

ask("Company?  ") { |q| q.default = "none" }

Validation:

ask("Age?  ", Integer) { |q| q.in = 0..105 }
ask("Name?  (last, first)  ") { |q| q.validate = /\A\w+, ?\w+\Z/ }

Type conversion for answers:

ask("Birthday?  ", Date)
ask("Interests?  (comma sep list)  ", lambda { |str| str.split(/,\s*/) })

Reading passwords:

ask("Enter your password:  ") { |q| q.echo = false }
ask("Enter your password:  ") { |q| q.echo = "x" }

ERb based output (with HighLine's ANSI color tools):

say("This should be <%= color('bold', BOLD) %>!")

Menus:

choose do |menu|
  menu.prompt = "Please choose your favorite programming language?  "

  menu.choice(:ruby) { say("Good choice!") }
  menu.choices(:python, :perl) { say("Not from around here, are you?") }
end

For more examples see the examples/ directory of this project.

Requirements

HighLine from version >= 1.7.0 requires ruby >= 1.9.3

Installing

See the INSTALL file for instructions.

Questions and/or Comments

Feel free to email James Edward Gray II or Gregory Brown with any questions.

Something went wrong with that request. Please try again.