brndnmtthws / conky Goto Github PK

📕 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 (with caveats), macOS, output to your console, a file, or even HTTP (oh my!).

👉 Grab the latest release from GitHub.

📹 An introduction to Conky (YouTube).

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, as well as handle mouse events.

See the User Configs below for more screenshots and associated config files.

Many package managers already include Conky. However, if you'd like to try the latest version of Conky, you can use the AppImage or the Nix flake.

To try the AppImage, head to https://github.com/brndnmtthws/conky/releases/latest and fetch the latest AppImage. You'll need to set the executable bit, then you can create a conkyrc, and run it as follows:

chmod +x ./conky-*.AppImage        # make it executable
./conky-*.AppImage -C > ~/.conkyrc # create a default config
./conky-*.AppImage                 # run

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.

As of Conky v1.17.0, there's a Nix flake available in addition to the upstream Nix package. You can include it as an input as follows:

{
  inputs = {
    conky.url = "github:brndnmtthws/conky";
  };
}

And use inputs.conky.packages.${system}.default (or inputs.conky.packages.${system}.conky for versions <=v1.19.8) to include the package. To use a specific version, add the git tag to the URL, such as github:brndnmtthws/conky?ref=refs/tags/v1.19.8.

Note that a Nix package exists in nixpkgs, and although it's not always up-to-date with the bleeding edge, it does offer more configuration options.

→ Reference documentation ←

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

• Installation
• Configuration Settings
• User Configs
• Frequently Asked Questions

Conky is licensed under the terms of the GPLv3 license.

Contributions are welcome from anyone.

Please read Contributing page on wiki for guidelines on contributing to Conky.

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.