Gem Version

Basic library for making interactive command-line applications much easier.


  • Easy way to add commands and help info to them so it can be shown to user.
  • Auto-completion for commands.
  • Command aliasing.



gem install cli-console


This library doesn't have any dependencies. Well actually there are no direct dependencies. In reality you do need HighLine. Then why did I say there's no dependencies? Because CLI::Console will accept any class implementing those few functions currently provided by HighLine.

Also, this library requires Ruby version 1.9.x or newer (works fine with 2.0)

Usage Example

Take a look at examples/shell.rb


YARD with markdown is used for documentation


RSpec and simplecov are required, to run tests just rake spec code coverage will also be generated

Code status

Build Status Dependency Status Coverage Status


Currently almost everything (all functions, files, text) in this repository are made by me @davispuh and I've dedicated this repository to public domain.



All text, documentation, code and files in this repository are in public domain (including this text, README). It means you can copy, modify, distribute and include in your own work/code, even for commercial purposes, all without asking permission.

About Unlicense


Feel free to improve anything what you see is improvable.

Warning: By sending pull request to this repository you dedicate any and all copyright interest in pull request (code files and all other) to the public domain. (files will be in public domain even if pull request doesn't get merged)

Also before sending pull request you acknowledge that you own all copyrights or have authorization to dedicate them to public domain.

If you don't want to dedicate code to public domain or if you're not allowed to (eg. you don't own required copyrights) then DON'T send pull request.