evilstudio / homelab-assistant-tool
CLI Tool which can help with manage your homelab devices.
Installs: 2
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Type:project
Requires
- php: ^8.3
- diegonz/php-wake-on-lan: ^2.1
- dragonmantank/cron-expression: ^3.4
- geerlingguy/ping: ^1.2
- monolog/monolog: ^3.7
- phpseclib/phpseclib: ^3.0
- symfony/config: ^7.1
- symfony/console: ^7.1
- symfony/dependency-injection: ^7.1
- symfony/filesystem: ^7.1
- symfony/process: ^7.1
- symfony/yaml: ^7.1
README
Overview
HAT is a tool to help manage a homelab. It is designed to be run on single node which is always on, and this node is used to manage the rest of the homelab.
Installation
- Create app via composer
composer create-project evilstudio/homelab-assistant-tool. - Copy
config/parameters.yaml.templatetoconfig/parameters.yamland set the correct values. - Check if your ssh key can be used to ssh into devices without password.
Commands Overview
Here is a list of commands available in HAT.
Be aware that some commands might not be available on all platforms.
| Command | Description | Usage |
|---|---|---|
| Show Devices | Show list of all devices. | php bin/console.php hat:device:show-all |
| Check Status | Check status of a specified device. | php bin/console.php hat:device:check-status |
| SSH Into Device | SSH into a specified device. | php bin/console.php hat:device:ssh |
| Start Device | Start a specified device via WOL. | php bin/console.php hat:device:start |
| Stop Device | Stop a specified device. | php bin/console.php hat:device:stop |
| Cron Job | Execute cron schedules should be added to crontab. |
php bin/console.php hat:cron:run |
NOTE: Logs for cron job can be found in var/logs/cron.log.