Go to file
Brenden Matthews bd5b7c87fa
Update/fix some web stuff. (#1429)
* Update/fix some web stuff.

Also added lefthook with some linting config.

* Add note about lefthook.

* Enable sort imports eslint rule.

* This statement is untrue

* Remove cypress video, add to gitignore

* Add web CI action

* Set the right dir here

* Try this
2023-02-25 20:12:11 -05:00
.github Update/fix some web stuff. (#1429) 2023-02-25 20:12:11 -05:00
3rdparty/toluapp Also replace this. 2023-02-16 21:54:40 -05: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 Bump version. 2023-02-24 08:35:48 -05:00
data Correct dependencies on generated header files 2022-09-10 13:14:13 -04:00
doc Add an above-all overlay mode for `own_window_type`, `utility` (#1402) 2023-02-16 22:03:14 -05:00
extras config: add out_to_wayland to bool setting list for config converter 2022-12-24 09:42:02 -05:00
logo Add AppImage integration. 2019-01-08 19:44:24 -05:00
lua chore: Fix imlib2 Lua bindings (#1405) 2023-02-17 11:49:04 -05:00
src Add some colour tests. 2023-02-24 19:41:02 -05:00
tests Fix these colour tests, refactor gcov script. 2023-02-25 14:22:43 -05:00
web Update/fix some web stuff. (#1429) 2023-02-25 20:12:11 -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
.gitignore Add basic Nix flake. 2023-01-01 13:44:29 -05: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 Update minimum cmake version. 2023-01-01 14:35:41 -05:00
CONTRIBUTING.md Update/fix some web stuff. (#1429) 2023-02-25 20:12:11 -05: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
LICENSE GPLv3 is the default license. 2018-01-25 09:26:33 -05:00
LICENSE.BSD Update copyright, authors. 2021-02-27 09:14:19 -06:00
README.cmake Deprecate autotools, update docs to reflect cmake build system. 2010-01-01 14:08:57 -08:00
README.docker Using X11 conky in a container 2018-02-18 18:17:22 +01:00
README.md Update README.md 2023-02-25 13:07:19 -05:00
TODO.md Add TODO for the gui-backends branch 2022-09-10 20:39:11 +02:00
conky.desktop Add AppImage integration. 2019-01-08 19:44:24 -05:00
flake.lock Add basic Nix flake. 2023-01-01 13:44:29 -05:00
flake.nix Add an above-all overlay mode for `own_window_type`, `utility` (#1402) 2023-02-16 22:03:14 -05:00
lefthook.yml Update/fix some web stuff. (#1429) 2023-02-25 20:12:11 -05:00
sonar-project.properties Add some basic unit tests. 2018-12-24 02:02:01 -05:00

README.md

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