https://github.com/andresgongora/synth-shell-greeter
A system status report and your personal ASCII-art logo for your terminal sessions
https://github.com/andresgongora/synth-shell-greeter
ascii-art ascii-logo bash report status system-healtcheck terminal
Last synced: 5 months ago
JSON representation
A system status report and your personal ASCII-art logo for your terminal sessions
- Host: GitHub
- URL: https://github.com/andresgongora/synth-shell-greeter
- Owner: andresgongora
- License: gpl-3.0
- Created: 2020-04-06T15:18:25.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-06-04T09:36:58.000Z (about 2 years ago)
- Last Synced: 2024-06-05T09:58:08.356Z (about 2 years ago)
- Topics: ascii-art, ascii-logo, bash, report, status, system-healtcheck, terminal
- Language: Shell
- Homepage:
- Size: 789 KB
- Stars: 12
- Watchers: 3
- Forks: 15
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Authors: AUTHORS.md
Awesome Lists containing this project
README
This script is part of [synth-shell](https://github.com/andresgongora/synth-shell)
**synth-shell-greeter** shows a summary of your system's current health.
- Automatically printed in new terminal sessions (local, SSH, ...).
- Monitor your servers, RaspberryPis, and workstations. All system info you
need at a glance (e.g. external IP address, CPU temperature, etc.).
- Detect broken services or CPU hogs.
- Print your own ASCII logo every time you log in.
# Setup
### Arch Linux
You may install `synth-shell-greeter` from AUR:
https://aur.archlinux.org/packages/synth-shell-greeter-git/
### Manual setup
The included [setup script](setup.sh) will guide you step by step through the
installation process. Just clone this repository and run it:
```
git clone --recursive https://github.com/andresgongora/synth-shell-greeter.git
synth-shell-greeter/setup.sh
```
You can then test your script by running it from wherever you installed it.
Usually this is to your user's `.config` folder, so you should run:
```
~/.config/synth-shell/synth-shell-greeter.sh
```
If you want it to appear everytime you open a new terminal, run
```
echo "~/.config/synth-shell/synth-shell-greeter.sh" >> ~/.bashrc
```
### Configuration/customization
You can configure your scripts by modifying the corresponding configuration
files. You can find them, along example configuration files, in the following
folders depending on how you installed **synth-shell**:
* Current-user only: `~/.config/synth-shell/`
* System wide: `/etc/synth-shell/`
# Overview
`synth-shell-greeter` provides a summarized system report at a single glance
every time you open up a new terminal. If it detects that any system parameter
(e.g. CPU load, memory, etc.) is over a critical threshold, it will provide a
warning and additional information about the cause. Last but not least, it
prints a user-configurable ASCII logo to impress your crush from the library
with how awesome you are.
Feel free to customize your status report through the many available options
in `~/.config/synth-shell/synth-shell-greeter.config` (user-only install) or
`/etc/synth-shell/synth-shell-greeter.config` (system-wide install), or by
replacing their content with the examples files you can find under the same
directory.
# Contribute
This project is only possible thanks to the effort and passion of many,
including developers, testers, and of course, our beloved coffee machine.
You can find a detailed list of everyone involved in the development
in [AUTHORS.md](AUTHORS.md). Thanks to all of you!
If you like this project and want to contribute, you are most welcome to do so.
### Help us improve
* [Report a bug](https://github.com/andresgongora/synth-shell/issues/new/choose):
if you notice that something is not right, tell us. We'll try to fix it ASAP.
* Suggest an idea you would like to see in the next release: send us
and email or open an [issue](https://github.com/andresgongora/synth-shell/issues)!
* Become a developer: fork this repo and become an active developer!
Take a look at the [issues](https://github.com/andresgongora/synth-shell/issues)
for suggestions of where to start. Also, take a look at our
[coding style](coding_style.md).
* Spread the word: telling your friends is the fastes way to get this code to
the people who might enjoy it!
# About
**synth-shell-greeter** is part of
[synth-shell](https://github.com/andresgongora/synth-shell)
# License
Copyright (c) 2014-2021, Andres Gongora - www.andresgongora.com
* This software is released under a GPLv3 license.
Read [license-GPLv3.txt](LICENSE),
or if not present, .
* If you need a closed-source version of this software
for commercial purposes, please contact the [authors](AUTHORS.md).