1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
.. image:: https://api.flattr.com/button/flattr-badge-large.png
:target: https://flattr.com/thing/484466/nicolargoglances-on-GitHub
.. 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://crate.io/packages/Glances
===============================
Glances - An eye on your system
===============================
.. image:: https://raw.github.com/nicolargo/glances/master/docs/images/glances-white-256.png
:width: 128
**Glances** is a cross-platform curses-based 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.2, 3.3)
- ``psutil >= 0.5.1`` (recommended version >= 0.6)
- ``jinja`` (optional for HTML output)
- ``pysensors`` (optional for HW monitoring support) [Linux-only]
- ``hddtemp`` (optional for HDD temperature monitoring support)
- ``batinfo`` (optional for battery monitoring support) [Linux-only]
- ``setuptools``
Installation
============
PyPI: The simple way
--------------------
Glances is on `PyPI`_. To install, simply use `pip`_:
.. code-block:: console
pip install Glances
To upgrade Glances to the latest version:
.. code-block:: console
pip install --upgrade Glances
Linux
-----
Actually, packages exist for Arch Linux, Fedora/CentOS/RHEL,
Debian (Sid/Testing) and Ubuntu (13.04+), so you should be able to
install it using your favorite package manager.
FreeBSD
-------
To install the precompiled binary package:
.. code-block:: console
# pkg_add -r 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 also install Glances using `Homebrew`_ or `MacPorts`_.
Homebrew
````````
.. code-block:: console
$ brew install brew-pip
$ export PYTHONPATH=$(brew --prefix)/lib/python2.7/site-packages
$ brew pip Glances
If you get the following error:
.. code-block:: console
Error: Failed executing: pip install glances==X.X --install-option=--prefix=/usr/local/XXX/glances/X.X (.rb:)
Try to run:
.. code-block:: console
$ pip install glances==X.X --install-option=--prefix=/usr/local/XXX/glances/X.X
$ brew link Glances
MacPorts
````````
.. code-block:: console
$ sudo port install glances
Windows
-------
Glances 1.7.2 proposes a Windows client based on the `colorconsole`_ Python library.
Glances < 1.7.2 only works in server mode. It will run in server mode automatically.
Thanks to Nicolas Bourges, Glances can be easily installed using a Windows installer:
- glances-1.6.1-x86.exe_ (32-bit, md5sum: 13d5be664599f80152f8f1ae47400576)
- glances-1.6.1-x64.exe_ (64-bit, md5sum: a347ec5097d6d4d5039c7233872757a8)
Otherwise, you have to follow these steps:
- Install Python for Windows: http://www.python.org/getit/
- Install the psutil library: https://code.google.com/p/psutil/downloads/list
- 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 from source:
.. code-block:: console
$ curl -L https://github.com/nicolargo/glances/archive/vX.X.tar.gz -o glances-X.X.tar.gz
$ tar -zxvf glances-*.tar.gz
$ cd glances-*
# python setup.py install
*Note*: Python headers are required to install psutil. For example, you need to install first:
* On Debian/Ubuntu, the *python-dev* package
* On CentOS/Fedora, the *python-devel* package (from the EPEL repository)
* On openSUSE/SLES/SLED, the *python-devel* package (from Oss repository)
Puppet
------
You can install Glances using `Puppet`_: https://github.com/rverchere/puppet-glances
Usage
=====
Just run:
.. code-block:: console
$ glances
Documentation
=============
For complete documentation see `glances-doc`_.
Author
======
Nicolas Hennion (@nicolargo) <nicolas@nicolargo.com>
License
=======
LGPL. See ``COPYING`` for more details.
.. _psutil: https://code.google.com/p/psutil/
.. _PyPI: https://pypi.python.org/pypi
.. _pip: http://www.pip-installer.org/
.. _Homebrew: http://mxcl.github.com/homebrew/
.. _MacPorts: https://www.macports.org/
.. _glances-1.6.1-x86.exe: https://s3.amazonaws.com/glances/glances-1.6.1-x86.exe
.. _glances-1.6.1-x64.exe: https://s3.amazonaws.com/glances/glances-1.6.1-x64.exe
.. _colorconsole: https://pypi.python.org/pypi/colorconsole
.. _Puppet: https://puppetlabs.com/puppet/what-is-puppet/
.. _glances-doc: https://github.com/nicolargo/glances/blob/master/docs/glances-doc.rst
|
