https://github.com/ryzeon-dev/sysfetch
Command-line system information tool written in Python
https://github.com/ryzeon-dev/sysfetch
Last synced: 2 months ago
JSON representation
Command-line system information tool written in Python
- Host: GitHub
- URL: https://github.com/ryzeon-dev/sysfetch
- Owner: ryzeon-dev
- License: cc0-1.0
- Created: 2023-05-31T05:33:05.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-29T10:17:06.000Z (about 1 year ago)
- Last Synced: 2025-02-04T15:47:17.538Z (4 months ago)
- Language: Python
- Homepage:
- Size: 942 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sysfetch
Command-line system information tool written in Python.\
Features hardware and operative system centered information.
Inspired by Neofetch and PowerLevel10k
## Install
To install sysfetch in your system, you need to execute "install.sh" file:
```commandline
$ ./install.sh full
$ ./install.sh update
```
The installation script needs a parameter, which can either be "full" or "update":
- if you choose "full":
- The script will create a folder called "sysfetch" in "/usr/share", and will copy "distros.py" into it.
- The "sysfetch" main script will be copied into "/usr/local/bin".
- A new folder named ".sysfetch" will be created in your home directory, in which there will be stored the configuration file and the cache file.
- if you choose "update":
- The script will copy the latest version of "sysfetch" script into "/usr/local/bin"
At a certain point you will be prompted for your password, in order to give root privileges to the script,
please DO NOT execute it as root beforehand.
It is also required to have installed the package "psutil",
which can be installed both by your distro's package manager or
by pip
```commandline
$ pip install psutil
```
## Usage
```commandline
$ sysfetch
```
To decrease execution time, Sysfetch implements a cacheing method,
which locally stores all "static" data featured.
If you want data to be recached, in case you changed something in
your device which concerns "static" data, simply use:
```commandline
$ sysfetch recache
```
It is a good practice to recache at least once a week.
If you desire to use a color different from default one (purple),
you can change it by:
```commandline
$ sysfetch color aquagreen
```
Available colors:
- grey
- red
- yellow
- purple
- green
- lightblue
- blue
- orange
- aquagreen
In case you want to see only the information (and not the distro's ascii art):
```commandline
$ sysfetch no-ascii-art
```
If you run this, the "no-ascii-art" behaviour will be cached. To revert it (and get back your ascii art), simply recache.
To ignore your configuration file:
```commandline
sysfetch ignore-conf
```
Similarly to "no-ascii-art", if you give the parameter "ignore-conf", its output will be cached. Use "recache" parameter to restore configuration
To get help about usage, it is available the "--help" option:
```commandline
$ sysfetch --help
```
If you wish to set a personalised default behaviour, you can edit the configuration file
located in "$HOME/.sysfetch/conf.json".
WARNING: do NOT delete any row or parameter in the configuration file, as it will cause sysfetch to crash.
In case you accidentally do, simply reinstall sysfetch specifying "full".
Default configuration:
```json
{
"ascii-art" : "",
"separator-unicode" : "",
"default-color" : "",
"always-recache" : false,
"no-ascii-art" : false,
"show" : {
"os" : true,
"kernel" : true,
"shell" : true,
"cpu" : true,
"cpu-arch" : true,
"cpu-cores" : true,
"cpu-threads" : true,
"cpu-usage" : true,
"cpu-temp" : true,
"load" : true,
"ram" : true,
"ram-usage" : true,
"ram-cached" : true,
"swap" : true,
"swap-usage" : true,
"swap-cached" : true,
"storage" : true,
"storage-usage" : true,
"gpu" : true,
"processes" : true,
"ipv4" : true,
"network-speed" : true,
"upload-speed" : true,
"download-speed" : true,
"disk-speed" : true,
"writing-speed" : true,
"reading-speed" : true
}
}
```
Setting as false any of the values in "show" section, removes the corresponding element from the displayed information.
Leave blank if you want to keep the standard behaviour.
Once done with conf.json, to load your changes it is required to recache.
Available always-recache values:
- true
- false
Available no-ascii-art values:
- true
- false
Available separator unicode:
- `empty`
- alpine
- macos
- arch
- debian
- kali
- parrot
- endeavour
- raspbian
- manjaro
- centos
- opensuse
- redhat
- sabayon
- slackware
- mandriva
- mangeia
- devuan
- tux
Available colors:
- `empty`
- grey
- red
- yellow
- purple
- green
- lightblue
- blue
- orange
- aquagreen
Available ascii-art:
- `empty`
- armbian
- aix
- alpine
- alterlinux
- anarchy
- android
- antergos
- antix
- aosc os
- aosc os/retro
- apricity
- arcolinux
- archbox
- archlabs
- archstrike
- xferience
- archmerge
- arch
- artix
- arya
- bedrock
- bitrig
- blackarch
- blag
- blankon
- bluelight
- bonsai
- bsd,bunsenlabs
- calculate
- carbs
- centos
- chakra
- chaletos
- chapeau
- chrom
- cleanjaro
- clearos
- clear_linux
- clover
- condres
- container_linux
- crux
- cucumber
- debian
- deepin
- desaos
- devuan
- dracos
- darkos
- dragonfly
- drauger
- elementary
- endeavouros
- endless
- eurolinux
- exherbo
- fedora
- feren
- freebsd
- freemint
- frugalware
- funtoo
- galliumos
- garuda
- gentoo
- pentoo
- gnewsense
- gnome
- gnu
- gobolinux
- grombyang
- guix
- haiku
- huayra
- hyperbola
- janus
- kali
- kaos
- kde_neon
- kibojoe
- kogaion
- korora
- kslinux
- kubuntu
- lede
- lfs
- linux_lite
- lmde
- lubuntu
- lunar
- macos
- mageia
- magpieos
- mandriva
- manjaro
- maui
- mer
- minix
- linuxmint
- mx_linux
- namib
- neptune
- netbsd
- netrunner
- nitrux
- nixos
- nurunner
- nutyx
- obrevenge
- openbsd
- openeuler
- openindiana
- openmamba
- openmandriva
- openstage
- openwrt
- osmc
- oracle
- os elbrus
- pacbsd
- parabola
- pardus
- parrot
- parsix
- trueos
- pclinuxos
- peppermint
- popos
- porteus
- postmarketos
- proxmox
- puppy
- pureos
- qubes
- radix
- raspbian
- reborn_os
- redstar
- redcore
- redhat
- refracted_devuan
- regata
- rosa
- sabotage
- sabayon
- sailfish
- salentos
- scientific
- septor
- serenelinux
- sharklinux
- siduction
- slackware
- slitaz
- smartos
- solus
- source_mage
- sparky
- star
- steamos
- sunos
- opensuse_leap
- opensuse_tumbleweed
- opensuse
- swagarch
- tails
- trisquel
- ubuntu-budgie
- ubuntu-gnome
- ubuntu-mate
- ubuntu-studio
- ubuntu
- venom
- void
- obarun
- windows10
- windows7
- xubuntu
- zorin
- irix
- tux