https://github.com/cheef/shell-spinner

Animated spinner for shell
https://github.com/cheef/shell-spinner

Last synced: about 2 months ago
JSON representation

Animated spinner for shell

• Host: GitHub
• URL: https://github.com/cheef/shell-spinner
• Owner: cheef
• License: mit
• Created: 2012-02-22T16:15:19.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2019-01-22T12:19:52.000Z (over 5 years ago)
• Last Synced: 2024-07-17T15:44:38.872Z (2 months ago)
• Language: Ruby
• Homepage:
• Size: 6.84 KB
• Stars: 10
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Shell Spinner

Gem provides animated spinner for UNIX shell and could be used with rake tasks and any console scripts.

It basically wraps any code and show spinner until code isn't completed.

## Installation

    gem install shell-spinner

    

In **Rails 3**, add this to your Gemfile and run the ```bundle``` command.

    

    gem "shell-spinner"

## Usage

The main gem function ```ShellSpinner``` accepts text string as first argument,

which is not required, but it's better to have it for pretty output.

And it accepts block of code. So spinner will be presented while block is running.

    require 'shell-spinner'

    # With message

    ShellSpinner "Positive result" do

      Rake::Task["foo:bar"].invoke

    end

    # Spinner without message

    ShellSpinner do

      sleep 1

    end

    # With exception

    ShellSpinner "Code with exception" do

      sleep 2

      raise "Some exception"

    end

This code produces output similar to:

    > Positive result... done

    > Code with exception... fail

    > 

    

I can't show you a spinner there, but promise - it appears :)

## Example

To see an example of the code in action you can execute `bin/example` from your terminal.