glances/README.rst

Follow Glances on Twitter: `@nicolargo`_ or `@glances_system`_

===============================
Glances - An eye on your system
===============================

.. image:: https://api.flattr.com/button/flattr-badge-large.png
        :target: https://flattr.com/thing/484466/nicolargoglances-on-GitHub
.. image:: https://scrutinizer-ci.com/g/nicolargo/glances/badges/quality-score.png?b=master
        :target: https://scrutinizer-ci.com/g/nicolargo/glances/
.. image:: https://travis-ci.org/nicolargo/glances.png?branch=master
        :target: https://travis-ci.org/nicolargo/glances
.. image:: https://badge.fury.io/py/Glances.png
        :target: http://badge.fury.io/py/Glances
.. image:: https://pypip.in/d/Glances/badge.png
        :target: https://pypi.python.org/pypi/Glances/
        :alt: Downloads
.. image:: https://d2weczhvl823v0.cloudfront.net/nicolargo/glances/trend.png
        :target: https://bitdeli.com/nicolargo

**Glances** is a cross-platform curses-based system monitoring tool
written in Python.

It uses the `psutil`_ library to get information from your system.

.. image:: https://raw.github.com/nicolargo/glances/master/docs/images/screenshot-wide.png

Requirements
============

- ``python >= 2.6`` (tested with version 2.6, 2.7, 3.3, 3.4)
- ``psutil >= 2.0.0``
- ``setuptools``

Optional dependencies:

- ``bottle`` (for Web server mode)
- ``py3sensors`` (for hardware monitoring support) [Linux-only]
- ``hddtemp`` (for HDD temperature monitoring support) [Linux-only]
- ``batinfo`` (for battery monitoring support) [Linux-only]
- ``pysnmp`` (for SNMP support)
- ``zeroconf`` and ``netifaces`` (for the auto discoverer mode)

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

Glances Auto Install script
---------------------------

To install both dependacies and latest  Glances version, just enter the following command line:

.. code-block:: console

    curl -L http://bit.ly/glances | /bin/bash

*Note*: Only supported on some GNU/Linux distributions.
If you want to support others distribs, please contribute to `glancesautoinstall`_.

PyPI: The simple way
--------------------

Glances is on `PyPI`_. By using PyPI, you are sure to have the latest
stable version.

To install, simply use `pip`_:

.. code-block:: console

    pip install Glances

*Note*: Python headers are required to install psutil. For example,
on Debian/Ubuntu you need to install first the *python-dev* package.

To upgrade Glances to the latest version:

.. code-block:: console

    pip install --upgrade Glances

GNU/Linux
---------

At the moment, packages exist for the following GNU/Linux distributions:

- Arch Linux
- Debian (Testing/Sid)
- Fedora/CentOS/RHEL
- Gentoo
- Slackware (SlackBuild)
- Ubuntu (13.04+)
- Void Linux

So you should be able to install it using your favorite package manager.

FreeBSD
-------

To install the binary package:

.. code-block:: console

    # pkg_add -r py27-glances

Using pkgng:

.. code-block:: console

    # pkg install py27-glances

To install Glances from ports:

.. code-block:: console

    # cd /usr/ports/sysutils/py-glances/
    # make install clean

OS X
----

OS X users can install Glances using `Homebrew`_ or `MacPorts`_.

Homebrew
````````

.. code-block:: console

    $ brew install python
    $ pip install Glances

MacPorts
````````

.. code-block:: console

    $ sudo port install glances

Windows
-------

- Install Python for Windows: http://www.python.org/getit/
- Install the psutil library: https://pypi.python.org/pypi?:action=display&name=psutil#downloads
- Install the `colorconsole`_ library: http://code.google.com/p/colorconsole/downloads/list
- Download Glances from here: http://nicolargo.github.io/glances/

Source
------

To install Glances version X.Y from source:

.. code-block:: console

    $ curl -L https://github.com/nicolargo/glances/archive/vX.Y.tar.gz -o glances-X.Y.tar.gz
    $ tar -zxvf glances-*.tar.gz
    $ cd glances-*
    # python setup.py install

*Note*: Python headers are required to install psutil. For example,
on Debian/Ubuntu you need to install first the *python-dev* package.

Puppet
------

You can install Glances using `Puppet`_: https://github.com/rverchere/puppet-glances

Usage
=====

For the standalone mode, just run:

.. code-block:: console

    $ glances


For the Web server mode, run:

.. code-block:: console

    $ glances -w

and enter the URL ``http://<ip>:61208`` in your favorite web browser.

For the client/server mode, run:

.. code-block:: console

    $ glances -s

on the server side and run:

.. code-block:: console

    $ glances -c <ip>

on the client one.

You can also detect and display all Glances servers available on your network or defined in the configuration file:

.. code-block:: console

    $ glances --browser

And RTFM, always.

Documentation
=============

For complete documentation see `glances-doc`_.

If you have any question (after RTFM !), please post it on the official Q&A `forum`_.

Author
======

Nicolas Hennion (@nicolargo) <nicolas@nicolargo.com>

License
=======

LGPL. See ``COPYING`` for more details.

.. _psutil: https://code.google.com/p/psutil/
.. _glancesautoinstall: https://github.com/nicolargo/glancesautoinstall
.. _@nicolargo: https://twitter.com/nicolargo
.. _@glances_system: https://twitter.com/glances_system
.. _PyPI: https://pypi.python.org/pypi
.. _pip: http://www.pip-installer.org/
.. _colorconsole: https://pypi.python.org/pypi/colorconsole
.. _glances-doc: https://github.com/nicolargo/glances/blob/master/docs/glances-doc.rst
.. _forum: https://groups.google.com/forum/?hl=en#!forum/glances-users