Skip to content

Commit

Permalink
add gif image to README closes #3
Browse files Browse the repository at this point in the history
  • Loading branch information
mogproject committed Jan 1, 2016
1 parent 8ef2329 commit ad1ad17
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.rst
Expand Up @@ -31,8 +31,11 @@ Features
Two commands will be installed.

* ``color-cat``: Similar to Linux's ``cat`` command, but the only difference is that the output is colored.
* The color is determined by the label string, therefore same label makes the output to be same color.
* ``color-ssh``: Execute remote commands via ``ssh`` with colored output. You can do parallel optionally.

.. image:: https://raw.githubusercontent.com/wiki/mogproject/color-ssh/files/demo.gif

------------
Dependencies
------------
Expand Down Expand Up @@ -65,7 +68,8 @@ Installation
Quickstart
----------

* color-cat
color-cat
---------

::

Expand All @@ -74,25 +78,26 @@ Quickstart
echo abc | color-cat -l label -s '=>' # specify separator
color-cat -l label README.rst # print the content of the file

* color-ssh
color-ssh
---------

Basic usage
* Basic usage

::

color-ssh server-1 ls -l # run command in server-1 with colored output
color-ssh server-1 'cd /tmp && pwd'
color-ssh --ssh 'ssh -v' username@server-1 id # overwrite ssh command to "ssh -v"

Parallel command executing
* Parallel command executing

::

color-ssh -h ~/hosts ls -l # load host list from file (each line "[user@]host[:port]")
color-ssh -H 'server-1 server-2' ls -l # specify server list within the command line
color-ssh -h ~/hosts -p 4 ls -l # specify parallelism

Uploading files and distributing command-line arguments
* Uploading files and distributing command-line arguments

::

Expand Down

0 comments on commit ad1ad17

Please sign in to comment.