pfetch/README.md

93 lines
1.7 KiB
Markdown
Raw Normal View History

2019-09-24 09:33:23 +02:00
# pfetch
A pretty system information tool written in POSIX `sh`.
2019-09-24 12:07:10 +02:00
```sh
➜ pfetch
___ goldie@KISS
(.· | os KISS Linux
(<> | host Lenovo YOGA 900-13ISK
/ __ \ kernel 5.3.1-coffee
( / \ /| uptime 6h 20m
_/\ __)/_) pkgs 130
\/-____\/ memory 1721MiB / 7942MiB
```
2019-09-24 12:43:18 +02:00
2019-09-24 20:08:33 +02:00
## OS support
- [x] Linux
- [x] MacOS
2019-09-25 09:35:55 +02:00
- [x] ~~Needs OS name detection.~~
- [x] ~~Needs testing.~~
2019-09-24 20:08:33 +02:00
- [x] OpenBSD
- [ ] Needs used memory detection.
2019-09-24 20:39:16 +02:00
- [ ] Needs testing.
2019-09-24 20:08:33 +02:00
- [x] FreeBSD
- [ ] Needs used memory detection.
2019-09-24 20:39:16 +02:00
- [ ] Needs testing.
2019-09-25 09:35:55 +02:00
- [x] NetBSD
- [ ] Needs used memory detection.
- [ ] Needs testing.
2019-09-24 20:08:33 +02:00
2019-09-24 13:50:14 +02:00
## Configuration
`pfetch` is configured through environment variables.
```sh
# Which information to display.
# NOTE: If 'ascii' will be used, it must come first.
2019-09-24 15:15:35 +02:00
# Default: first example below
2019-09-24 13:50:14 +02:00
# Valid: space separated string
2019-09-24 21:52:13 +02:00
#
# OFF by default: shell
2019-09-24 13:50:14 +02:00
PF_INFO="ascii title distro host kernel uptime pkgs memory"
# Example: Only ASCII.
PF_INFO="ascii"
# Example: Only Information.
PF_INFO="title distro host kernel uptime pkgs memory"
# Separator between info name and info data.
2019-09-24 15:15:35 +02:00
# Default: unset
2019-09-24 13:50:14 +02:00
# Valid: string
PF_SEP=":"
# Color of info names:
2019-09-24 15:15:35 +02:00
# Default: unset (auto)
2019-09-24 13:50:14 +02:00
# Valid: 0-9
PF_COL1=4
# Color of info data:
2019-09-24 15:15:35 +02:00
# Default: unset (auto)
2019-09-24 13:50:14 +02:00
# Valid: 0-9
PF_COL2=7
2019-09-25 09:40:36 +02:00
# Color of title data:
# Default: unset (auto)
# Valid: 0-9
PF_COL3=1
2019-09-24 13:50:14 +02:00
# Alignment padding.
2019-09-24 15:15:35 +02:00
# Default: unset (auto)
2019-09-24 13:50:14 +02:00
# Valid: int
PF_ALIGN=""
2019-09-24 15:15:35 +02:00
# Which ascii art to use.
# Default: unset (auto)
# Valid: string
PF_ASCII="openbsd"
2019-09-24 13:50:14 +02:00
```
2019-09-24 15:09:13 +02:00
## Make `pfetch` update on an interval
This makes `pfetch` display interactively like `htop`/`top`.
```sh
watch -tn1 pfetch
```
2019-09-24 20:52:25 +02:00
## Credit
- [ufetch](https://gitlab.com/jschx/ufetch): Lots of ASCII logos.