mirror of
https://github.com/Llewellynvdm/conky.git
synced 2024-11-18 02:55:12 +00:00
110 lines
5.2 KiB
Markdown
110 lines
5.2 KiB
Markdown
[](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)
|
|
|
|
[📕 Documentaton](https://conky.cc/)
|
|
|
|
[💬 Join the Matrix chat](https://matrix.to/#/#conky:frens.io)
|
|
|
|
<p align="center"><img width="300" src="logo/conky-logotype-horizontal-violet.png"></p>
|
|
|
|
**Conky** is a free, light-weight system monitor for X, that displays
|
|
any kind of information on your desktop. It can also run on macOS, output
|
|
to your console, a file, or even HTTP (oh my!).
|
|
|
|
👉 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).
|
|
|
|
## Features
|
|
|
|
Conky can display more than 300 built-in objects, including support for:
|
|
|
|
- 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.
|
|
- Built-in support for many popular music players ([MPD][],
|
|
[XMMS2][], [Audacious][]).
|
|
- 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)).
|
|
- Runs on Linux, FreeBSD, OpenBSD, DragonFlyBSD, NetBSD, Solaris, Haiku, and macOS!
|
|
- [Docker image](https://hub.docker.com/r/brndnmtthws/conky/) available for amd64, armv7, and aarch64 (aka armv8)
|
|
|
|
... and much much more.
|
|
|
|
Conky can display information either as text, or using simple progress
|
|
bars and graph widgets, with different fonts and colours.
|
|
|
|
## Screenshots
|
|
|
|
[](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)
|
|
|
|
See the User Configs below for more screenshots and associated config files.
|
|
|
|
## 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.
|
|
|
|
## Documentation
|
|
|
|
→ [**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:
|
|
|
|
- [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)
|
|
|
|
## License
|
|
|
|
Conky is licensed under the terms of the [GPLv3](LICENSE) license.
|
|
|
|
## Contributing
|
|
|
|
Contributions are welcome from anyone.
|
|
|
|
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on contributing to Conky.
|
|
|
|
[mpd]: https://musicpd.org/
|
|
[xmms2]: https://github.com/xmms2/wiki/wiki
|
|
[audacious]: https://audacious-media-player.org/
|
|
[luawiki]: https://en.wikipedia.org/wiki/Lua_%28programming_language%29
|
|
[imlib2]: https://docs.enlightenment.org/api/imlib2/html/
|
|
[cairo]: https://www.cairographics.org/
|
|
|
|
## Supporting this project
|
|
|
|
Conky exists only through the hard work of a collection of volunteers. Please
|
|
consider sponsoring the project's developers if you get value out of Conky.
|
|
|
|
## Stargazers over time
|
|
|
|
[](https://starchart.cc/brndnmtthws/conky)
|