name:
distro:
uptime:
https://github.com/mik30s/cysboard
A lightweight system monitor similar to conky with html and css for themes
https://github.com/mik30s/cysboard
conky cpu css eye-candy html linux theme
Last synced: 11 months ago
JSON representation
A lightweight system monitor similar to conky with html and css for themes
- Host: GitHub
- URL: https://github.com/mik30s/cysboard
- Owner: mik30s
- License: gpl-3.0
- Created: 2016-12-29T01:35:15.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-06-07T16:17:51.000Z (over 8 years ago)
- Last Synced: 2023-10-19T22:09:36.860Z (over 2 years ago)
- Topics: conky, cpu, css, eye-candy, html, linux, theme
- Language: C++
- Homepage:
- Size: 23 MB
- Stars: 155
- Watchers: 20
- Forks: 17
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
Cysboard
=========
A lightweight system monitor similar to conky but with html and css for themes
## Usage
1. Create a theme file called main.html in ~/.config/cysboard/ (There must be a file name 'main.html').
2. Add your html code with any of the listed ids below in html tags for device info.
3. Run cysboard.
If a 'main.html' file does not exist in the config directory cysboard will start with a default theme.
## Compiling
You must have cmake >= 3.1 and gcc >= 5.4 in order to compile
1. mkdir build
2. cmake .
3. make
## Examples
Use ids like the following
```html
Cysboard
SYSTEM
CPU
model:
vendor:
arch:
usage: %
RAM
free: KB
used: KB
Program 1 Output:
Program 2 Output:
![]()
```
Please see sources/resources/default.html for a working theme.
## IDs
A list of currently supported information from sources. Add any of
them as an *id* attribute for a tag in your theme file.
ID | Info
-------------- | -----------------
cpu_name | The CPU's name
cpu_usage | The total usage of the CPU in percentages
cpu_arch | The CPU's architecture
cpu_vendor | The CPU vendor eg. Intel, AMD
cpu_num_cores | The number of physical cores
mem_free | The amount of free memory in KB, MB or GB
mem_used | The amount of used memory in KB, MB or GB
mem_swap_total | The amount of swap memory in KB, MB or GB
mem_total | The total amount of physical memory available
os_name | The name of the OS
os_distro_name | The distribution name (*Linux only*)
os_uptime | The total amount of time since last boot
os_num_procs | The number of running processes
exec_# | Execute a program and display its output eg. *exec_0, exec_1* etc.
cpu_usage_# | Get a cpu core's usage percentage eg. *cpu_usage_0, cpu_usage_1* etc.
Some IDs require attributes and can be used like this
```html
Free RAM:
```
Atrribute | Description | Applicable ID(s)
----------------| --------------------------------- | ---------------------------------------------
mul | Display value in MB, KB or GB | mem_free, mem_used, mem_swap_total, mem_total
cmd | Path of program to execute | exec_#
## Project structure
The source code for the project is located in the source directory.
The header file `cysboard.h` contains the main update function for the program.
Objects for information from or about the cpu, os, memory and others are initialized in this class.
All the other files house classes for gathering information from various sources. For example `cpuinfo_linux.cpp` has functions for gathering cpu info on a system. The header file `util.h` holds functions for common and repetitive tasks.
## Known Issues
1. Program crashes sometimes when editing themes.
## Todo
1. GPU, Disk and Network information.
2. Add graph and bar controls like conky.
3. Run commands from theme file.