spin

command module
v0.0.0-...-17311aa Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 2, 2019 License: MIT Imports: 10 Imported by: 0

README

****
spin
****

.. image:: http://i.imgur.com/JyfyJg9.gif
   :alt: usage example

The universal tool that provides the dead simple progress indicator.

Installation
============

**spin** is go-gettable::

 go get github.com/kovetskiy/spin

Usage
=====

See ``spin --help`` for command line options.

``-i --stdin-as-indicator``   Use stdin data as progress indicator.

``-o --write-stdin``          Write stdin to spinner's stdout on exit.

``-s --status <string>``      Use specified ``<string>`` as spinner status.

``-t --interval <millisec>``  Use specified ``<millisec>`` as spinner iteration interval. [default: 100]

All you need to do is pipe any command to spin as follows::

 sleep 2 | spin -s 'Loading... '

and your shell will spawn ``spin`` process and terminate it when ``sleep`` exited.

If you want to indicate real progress you can use flag ``-i`` and spin will
use stdin data as progress indicator::

 git clone --progress https://github.com/kovetskiy/dotfiles 2>&1 | spin -i -s 'Cloning... '

License
=======

MIT.

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL