2021-03-02 21:07:39 +00:00
[](https://github.com/brndnmtthws/conky/actions/workflows/build-and-test-linux.yaml) [](https://github.com/brndnmtthws/conky/actions/workflows/build-and-test-macos.yaml) [](https://github.com/brndnmtthws/conky/actions/workflows/docker.yaml) [](https://github.com/brndnmtthws/conky/actions/workflows/publish-appimage.yml)
2022-10-02 00:11:55 +00:00
[📕 Documentaton ](https://conky.cc/ )
2021-03-25 13:22:49 +00:00
[💬 Join the Matrix chat ](https://matrix.to/#/#conky:frens.io )
2019-02-25 18:28:56 +00:00
2023-03-28 12:21:17 +00:00
< p align = "center" > < img width = "300" src = "data/logo/conky-logotype-horizontal-violet.png" > < / p >
2012-12-26 00:57:10 +00:00
**Conky** is a free, light-weight system monitor for X, that displays
2023-02-25 18:07:19 +00:00
any kind of information on your desktop. It can also run on Wayland, macOS, output
2022-09-19 16:14:41 +00:00
to your console, a file, or even HTTP (oh my!).
2012-12-26 00:57:10 +00:00
2019-01-03 01:17:09 +00:00
👉 Grab the [latest release from GitHub ](https://github.com/brndnmtthws/conky/releases/latest ).
[📹 An introduction to Conky (YouTube) ](https://www.youtube.com/watch?v=bHtpLEoRKmg&t=19s ).
2015-11-18 15:47:45 +00:00
2019-03-03 15:27:07 +00:00
## Features
2012-12-26 00:57:10 +00:00
Conky can display more than 300 built-in objects, including support for:
2019-03-03 15:27:07 +00:00
- A plethora of OS stats (uname, uptime, **CPU usage** , **mem
usage**, disk usage, ** "top"** like process stats, and **network
monitoring**, just to name a few).
- Built-in **IMAP** and **POP3** support.
2023-11-10 22:07:02 +00:00
- Built-in support for many popular music players ([MPD][],
[XMMS2][], [Audacious][]).
2019-03-03 15:27:07 +00:00
- Can be extended using built-in [**Lua** ](lua ) support, or any of your
own scripts and programs ([more](https://github.com/brndnmtthws/conky/wiki#tutorial)).
- Built-in [**Imlib2**][imlib2] and [**Cairo**][cairo] bindings for arbitrary drawing
with Lua ([more](https://github.com/brndnmtthws/conky/wiki/Lua)).
2020-12-25 19:34:25 +00:00
- Runs on Linux, FreeBSD, OpenBSD, DragonFlyBSD, NetBSD, Solaris, Haiku, and macOS!
2021-02-27 15:55:46 +00:00
- [Docker image ](https://hub.docker.com/r/brndnmtthws/conky/ ) available for amd64, armv7, and aarch64 (aka armv8)
2012-12-26 00:57:10 +00:00
... and much much more.
2023-11-10 08:09:01 +00:00
Conky can display information either as text, or using simple progress bars and
graph widgets, with different fonts and colours, as well as handle [mouse events ](https://github.com/brndnmtthws/conky/wiki/Mouse-Events ).
2012-12-26 00:57:10 +00:00
2019-03-03 15:27:07 +00:00
## Screenshots
2012-12-26 00:57:10 +00:00
2013-03-28 21:29:47 +00:00
[](https://raw.github.com/wiki/brndnmtthws/conky/configs/brenden/screenshot.png)
[](https://raw.github.com/wiki/brndnmtthws/conky/configs/ke49/screenshot.png)
[](https://raw.github.com/wiki/brndnmtthws/conky/configs/jc/screenshot.png)
2012-12-26 00:57:10 +00:00
2018-08-07 19:58:41 +00:00
See the User Configs below for more screenshots and associated config files.
2012-12-26 00:57:10 +00:00
2019-03-06 14:28:45 +00:00
## Quickstart
Conky comes bundled with many package managers. However, if you'd like to try the latest release of Conky, you can try the AppImage build. If you have `jq` and `curl` installed, run the following command to fetch the latest AppImage:
```ShellSession
$ curl -sL -o conky-x86_64.AppImage \
$(curl -sL https://api.github.com/repos/brndnmtthws/conky/releases/latest | \
jq --raw-output '.assets[0] | .browser_download_url')
$ ls
conky-x86_64.AppImage
```
If you don't have `jq` and `curl` installed, go to
https://github.com/brndnmtthws/conky/releases/latest and fetch the latest
AppImage. Then:
```ShellSession
$ chmod +x ./conky-x86_64.AppImage
$ ./conky-x86_64.AppImage -C > ~/.conkyrc
$ ./conky-x86_64.AppImage
```
And that's it! [Check out the Wiki ](https://github.com/brndnmtthws/conky/wiki ) for more details on configuring Conky.
_Note_: To use the AppImage, you may need to install additional runtime libraries.
2019-03-03 15:27:07 +00:00
## Documentation
2012-12-26 00:57:10 +00:00
2022-10-02 00:11:55 +00:00
→ [**Reference documentation** ](https://conky.cc/ ) ←
The [Conky Wiki ](https://github.com/brndnmtthws/conky/wiki ) also serves as a central hub for
Conky. Some resources from the Wiki include:
2012-12-26 00:57:10 +00:00
2019-03-03 15:27:07 +00:00
- [Installation ](https://github.com/brndnmtthws/conky/wiki/Installation )
- [Configuration Settings ](https://github.com/brndnmtthws/conky/wiki/Configurations )
- [User Configs ](https://github.com/brndnmtthws/conky/wiki/Configs )
- [Frequently Asked Questions ](https://github.com/brndnmtthws/conky/wiki/FAQ )
2012-12-26 00:57:10 +00:00
2019-03-03 15:27:07 +00:00
## License
2012-12-26 00:57:10 +00:00
2019-03-03 02:34:53 +00:00
Conky is licensed under the terms of the [GPLv3 ](LICENSE ) license.
2012-12-26 00:57:10 +00:00
2019-03-03 15:27:07 +00:00
## Contributing
Contributions are welcome from anyone.
2016-07-13 14:29:51 +00:00
2019-03-03 16:33:11 +00:00
Please read [CONTRIBUTING.md ](CONTRIBUTING.md ) for guidelines on contributing to Conky.
2019-03-03 15:27:07 +00:00
[mpd]: https://musicpd.org/
[xmms2]: https://github.com/xmms2/wiki/wiki
[audacious]: https://audacious-media-player.org/
2018-08-07 19:58:41 +00:00
[luawiki]: https://en.wikipedia.org/wiki/Lua_%28programming_language%29
2019-03-03 15:27:07 +00:00
[imlib2]: https://docs.enlightenment.org/api/imlib2/html/
2018-08-07 19:58:41 +00:00
[cairo]: https://www.cairographics.org/
2021-02-27 15:55:46 +00:00
## Supporting this project
Conky exists only through the hard work of a collection of volunteers. Please
2021-02-27 15:56:31 +00:00
consider sponsoring the project's developers if you get value out of Conky.
2021-02-27 15:55:46 +00:00
## Stargazers over time
[](https://starchart.cc/brndnmtthws/conky)
