PHPackages evilstudio/homelab-assistant-tool - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. evilstudio/homelab-assistant-tool ActiveProject[Utility & Helpers](/categories/utility) evilstudio/homelab-assistant-tool ================================= CLI Tool which can help with manage your homelab devices. v2.1.3(2mo ago)02MITPHPPHP ^8.3 Since Nov 16Pushed 2mo ago1 watchersCompare [ Source](https://github.com/evilprophet/homelab-assistant-tool)[ Packagist](https://packagist.org/packages/evilstudio/homelab-assistant-tool)[ RSS](/packages/evilstudio-homelab-assistant-tool/feed)WikiDiscussions 2.x Synced 1mo ago READMEChangelogDependencies (18)Versions (23)Used By (0) ๐Ÿค– Homelab Assistant Tool (HAT) ============================== [](#-homelab-assistant-tool-hat) Introduction ------------ [](#introduction) Homelab Assistant Tool is an application for homelab operations and automation. It combines a CLI interface with a Web UI for managing devices, UPS units, schedules, and operational logs. For technical details, see [Tech Stack](./docs/tech-stack.md). โœจ Key Features -------------- [](#-key-features) - `๐Ÿ”Œ Device operations` - Start, stop, check status, and SSH operations for managed devices (via CLI) - `๐Ÿ”‹ UPS-aware behavior` - UPS monitoring support and battery-aware automation logic - `โฐ Scheduling` - Cron-based automation with schedule-to-device assignment - `๐Ÿงพ Action logs` - Unified action history for `CLI`, `CRON`, and `WEB` operations - Log filtering and cleanup tools - `๐ŸŒ Web UI` - Management views for devices, UPS, schedules, and logs - Manual operational actions from the browser - `๐Ÿ” Authentication` - `simple` mode (local username/password) - `oidc` mode (OIDC provider login) ๐Ÿ“ Project Structure ------------------- [](#-project-structure) ``` . โ”œโ”€โ”€ bin/ # CLI entrypoints and helper scripts โ”œโ”€โ”€ config/ # Symfony and app configuration โ”œโ”€โ”€ docs/ # Main technical documentation โ”œโ”€โ”€ migrations/ # Doctrine migrations โ”œโ”€โ”€ public/ # Web entrypoint and built assets โ”œโ”€โ”€ src/ # Application source code โ”‚ โ”œโ”€โ”€ Command/ # CLI commands (setup, CRUD, runtime, users) โ”‚ โ”œโ”€โ”€ Contract/ # Runtime contracts and enums โ”‚ โ”œโ”€โ”€ Controller/ # Web controllers โ”‚ โ”œโ”€โ”€ Entity/ # Doctrine entities โ”‚ โ”œโ”€โ”€ EventSubscriber/ # Request/auth/log subscribers โ”‚ โ”œโ”€โ”€ Factory/ # Runtime factories/adapters โ”‚ โ”œโ”€โ”€ Helper/ # Configuration and helpers โ”‚ โ”œโ”€โ”€ Repository/ # Doctrine repositories โ”‚ โ”œโ”€โ”€ Runtime/ # Runtime models โ”‚ โ””โ”€โ”€ Service/ # Application, runtime, auth, infrastructure services โ”œโ”€โ”€ templates/ # Twig templates (dashboard, devices, ups, schedules, logs, auth) โ”œโ”€โ”€ tests/ # Unit, integration, and functional test suites โ””โ”€โ”€ var/ # Runtime data, cache, logs, SQLite files ``` ๐Ÿš€ Quick Start ------------- [](#-quick-start) ### 1. Clone and install [](#1-clone-and-install) ``` git clone https://github.com/evilstudio/homelab-assistant-tool.git cd homelab-assistant-tool composer install cp .env.example .env ``` ### 2. Update `.env` [](#2-update-env) Set values for your environment (application/auth settings, and OIDC values when using `HAT_AUTH_MODE=oidc`). ### 3. Configure application settings [](#3-configure-application-settings) ``` php bin/console hat:setup:configure ``` ### 4. Initialize database [](#4-initialize-database) ``` php bin/console hat:setup:db --init ``` ### 5. Create first user (simple auth mode) [](#5-create-first-user-simple-auth-mode) ``` php bin/console hat:user:create ``` ### 6. Run Web UI (Docker Compose) [](#6-run-web-ui-docker-compose) ``` docker compose up -d --build ``` Open: `http://localhost:8080` For local development with Xdebug and dedicated compose config: ``` docker compose -f docker-compose.dev.yml up -d --build ``` ### 7. Run CLI commands [](#7-run-cli-commands) ``` php bin/console list ``` ๐Ÿ’ป Commands Overview ------------------- [](#-commands-overview) Here is a list of commands available in HAT. CommandDescription`hat:setup:configure`Configure app technical settings.`hat:setup:db`Initialize/migrate SQLite database.`hat:setup:init`Run full setup flow.`hat:device:create/update/remove/list`Manage devices.`hat:ups:create/update/remove/list`Manage UPS entries.`hat:schedule:create/update/remove/list`Manage schedules.`hat:device:check-status`Check runtime status for a device.`hat:device:ssh`Open SSH session to a device.`hat:device:start`Start a device.`hat:device:stop`Stop a device.`hat:cron:execute`Execute scheduled tasks and maintenance.`hat:logs:list`List action logs stored in DB.`hat:logs:cleanup`Remove old/all action logs from DB.`hat:user:create`Create local user for simple auth mode.`hat:user:remove`Remove local user in simple auth mode.`hat:user:reset-password`Reset local user password (simple mode).๐Ÿงญ Notes ------- [](#-notes) - Business data is stored in SQLite. - Integration/functional tests use separate SQLite DB (`var/data/hat_test.sqlite`). - Runtime settings are configured in `config/parameters.yaml`. - Web logs are written to `var/log/web.log`. ๐Ÿงช Testing & Quality ----------------------- [](#-testing--quality) ### Quick Start: [](#quick-start) ``` # Run all tests (Xdebug off) bin/phpunit # Run with coverage report bin/phpunit-coverage ``` ### ๐Ÿ“š Documentation: [](#-documentation) - ๐Ÿ“– **[Test Implementation Summary](./docs/test-implementation-summary.md)** - Overview and current scope - ๐Ÿš€ **[CI/CD Guide](./docs/test-ci-cd-guide.md)** - GitLab pipeline setup ### Health Score 42 โ€” FairBetter than 90% of packages Maintenance86 Actively maintained with recent releases Popularity2 Limited adoption so far Community7 Small or concentrated contributor base Maturity63 Established project with proven stability Bus Factor1 Top contributor holds 100% of commits โ€” single point of failure How is this calculated?**Maintenance (25%)** โ€” Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** โ€” Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** โ€” Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** โ€” Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~21 days Recently: every ~1 days Total 23 Last Release 68d ago Major Versions v1.4.4 โ†’ v2.0.02026-03-01 ### Community Maintainers ![](https://www.gravatar.com/avatar/f1f94e259c38b695cc8df4d2dd4151ca6f282b2fedc57afabbf6af61e27e41ff?d=identicon)[evilprophet](/maintainers/evilprophet) --- Top Contributors [![evilprophet](https://avatars.githubusercontent.com/u/9113198?v=4)](https://github.com/evilprophet "evilprophet (52 commits)") --- Tags helpertoolassistanthomelab ### Code Quality TestsPHPUnit Code StylePHP\_CodeSniffer ### Embed Badge ![Health badge](/badges/evilstudio-homelab-assistant-tool/health.svg) ``` [![Health](https://phpackages.com/badges/evilstudio-homelab-assistant-tool/health.svg)](https://phpackages.com/packages/evilstudio-homelab-assistant-tool) ``` ### Alternatives [kimai/kimai Kimai - Time Tracking 4.6k7.4k1](/packages/kimai-kimai)[sylius/sylius E-Commerce platform for PHP, based on Symfony framework. 8.4k5.6M651](/packages/sylius-sylius)[ec-cube/ec-cube EC-CUBE EC open platform. 78527.0k1](/packages/ec-cube-ec-cube)[shopware/platform The Shopware e-commerce core 3.3k1.5M3](/packages/shopware-platform)[forumify/forumify-platform 121.8k11](/packages/forumify-forumify-platform)[prestashop/prestashop PrestaShop is an Open Source e-commerce platform, committed to providing the best shopping cart experience for both merchants and customers. 9.0k15.4k](/packages/prestashop-prestashop) PHPackages ยฉ 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)