1
0
mirror of https://github.com/Llewellynvdm/conky.git synced 2024-12-25 12:10:03 +00:00
Go to file
Tin Svagelj afa5f326e8
Prepare environment
Signed-off-by: Tin Svagelj <tin.svagelj@live.com>
2023-11-19 14:14:59 -05:00
.github build(deps): bump actions/setup-node from 3 to 4 2023-10-23 15:43:53 -04:00
.vscode Add nix flake dev shell, direnv, VSCode extensions, CI 2023-06-24 14:35:36 -04:00
3rdparty/toluapp Preserve ordering of generated Lua code (#1646) 2023-10-13 09:51:50 -04:00
appimage Use the cmake commands here instead. (#1346) 2022-12-26 13:54:10 -05:00
bin Fix python command for clang checks (2 -> 3). 2020-01-08 13:20:17 -05:00
cmake Prepare environment 2023-11-19 14:14:59 -05:00
data feat: Move docs to website, rearrange bits (#1475) 2023-03-28 08:21:17 -04:00
doc Improve speedgraph scale descriptions in docs 2023-11-08 13:28:59 -05:00
extras Combine vim ftdetect commands 2023-05-19 11:57:40 -04:00
lua lua cairo: Add mesh patterns. 2023-04-12 11:11:19 -04:00
src Prepare environment 2023-11-19 14:14:59 -05:00
tests gradient: initialize alpha when converting from rgb (#1491) 2023-04-05 09:07:32 -04:00
web Run npm audit fix 2023-11-08 14:55:27 -05:00
.clang-format Make GitLab build work with clang checks. 2019-02-23 17:13:19 -05:00
.clang-tidy Make GitLab build work with clang checks. 2019-02-23 17:13:19 -05:00
.dockerignore Update dockerignore. 2021-03-02 08:02:53 -06:00
.editorconfig Apply a bunch of code fixes from sonarcloud. (#492) 2018-05-13 09:58:03 -04:00
.envrc Add nix flake dev shell, direnv, VSCode extensions, CI 2023-06-24 14:35:36 -04:00
.gitignore Add nix flake dev shell, direnv, VSCode extensions, CI 2023-06-24 14:35:36 -04:00
.prettierrc.cjs Update/fix some web stuff. (#1429) 2023-02-25 20:12:11 -05:00
AUTHORS FreeBSD: Additional memory reporting variables. 2022-12-24 08:55:20 -05:00
CMakeLists.txt feat: Move docs to website, rearrange bits (#1475) 2023-03-28 08:21:17 -04:00
COPYING Update copyright, authors. 2021-02-27 09:14:19 -06:00
Dockerfile Parameterize the cmake version. 2023-01-01 17:35:15 -05:00
flake.lock Add nix flake dev shell, direnv, VSCode extensions, CI 2023-06-24 14:35:36 -04:00
flake.nix Get rid these 2023-06-26 19:43:34 -04:00
lefthook.yml Try the magic cache, use -y with npx 2023-06-26 19:43:34 -04:00
LICENSE.BSD Update copyright, authors. 2021-02-27 09:14:19 -06:00
LICENSE.md feat: Move docs to website, rearrange bits (#1475) 2023-03-28 08:21:17 -04:00
README.cmake Deprecate autotools, update docs to reflect cmake build system. 2010-01-01 14:08:57 -08:00
README.md feat: Move docs to website, rearrange bits (#1475) 2023-03-28 08:21:17 -04:00

Linux build macOS build Docker build AppImage build

📕 Documentaton

💬 Join the Matrix chat

Conky is a free, light-weight system monitor for X, that displays any kind of information on your desktop. It can also run on Wayland, macOS, output to your console, a file, or even HTTP (oh my!).

👉 Grab the latest release from GitHub.

📹 An introduction to Conky (YouTube).

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 support, or any of your own scripts and programs (more).
  • Built-in Imlib2 and Cairo bindings for arbitrary drawing with Lua (more).
  • Runs on Linux, FreeBSD, OpenBSD, DragonFlyBSD, NetBSD, Solaris, Haiku, and macOS!
  • Docker image 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

screenshot screenshot screenshot

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:

$ 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:

$ chmod +x ./conky-x86_64.AppImage
$ ./conky-x86_64.AppImage -C > ~/.conkyrc
$ ./conky-x86_64.AppImage

And that's it! Check out the Wiki for more details on configuring Conky.

Note: To use the AppImage, you may need to install additional runtime libraries.

Documentation

Reference documentation

The Conky Wiki also serves as a central hub for Conky. Some resources from the Wiki include:

License

Conky is licensed under the terms of the GPLv3 license.

Contributing

Contributions are welcome from anyone.

Please read CONTRIBUTING.md for guidelines on contributing to Conky.

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

Stargazers over time