CLIProgressBar

A progress bar for the command line, written in ruby.

require "cli_progress_bar"

progress_bar = CLIProgressBar.new(of: "2.3 MiB")

progress_bar.update(20)
progress_bar.update(40)
progress_bar.update(60)
progress_bar.update(80)
progress_bar.update(100)

Produces an output of:

[----------->                                                ]  20% of 2.3 MiB
[----------------------->                                    ]  40% of 2.3 MiB
[----------------------------------->                        ]  60% of 2.3 MiB
[----------------------------------------------->            ]  80% of 2.3 MiB
[----------------------------------------------------------->]  100% of 2.3 MiB

There are many out there but this progress bar...

• Is fully customisable with sensible defaults out of the box
• Has good examples to copy and paste from
• Has zero dependencies
• Is heavily unit tested

Install the gem and add to the application's Gemfile by executing:

bundle add cli_progress_bar

If bundler is not being used to manage dependencies, install the gem by executing:

gem install cli_progress_bar

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/michaeltelford/cli_progress_bar.

The gem is available as open source under the terms of the MIT License.