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.4.3(2mo ago)02MITPHPPHP ^8.3CI passing 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 today READMEChangelogDependencies (36)Versions (33)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) You can run HAT in two ways. ### Option 1: Docker only (without cloning the full repository) [](#option-1-docker-only-without-cloning-the-full-repository) #### 1. Download `docker-compose.yml`, `.env.example`, and `config/parameters.yaml` [](#1-download-docker-composeyml-envexample-and-configparametersyaml) ``` mkdir -p config var/data curl -L -o docker-compose.yml https://raw.githubusercontent.com/evilstudio/homelab-assistant-tool/main/docker-compose.yml curl -L -o .env https://raw.githubusercontent.com/evilstudio/homelab-assistant-tool/main/.env.example curl -L -o config/parameters.yaml https://raw.githubusercontent.com/evilstudio/homelab-assistant-tool/main/config/parameters.yaml ``` #### 2. Update `.env` and `config/parameters.yaml` [](#2-update-env-and-configparametersyaml) Set values for your environment (`.env` for app/auth settings and OIDC values when using `HAT_AUTH_MODE=oidc`, `config/parameters.yaml` for runtime settings). #### 3. Pull GHCR image [](#3-pull-ghcr-image) ``` docker compose pull ``` #### 4. Run initial setup commands [](#4-run-initial-setup-commands) ``` docker compose run --rm hat-app php bin/console hat:setup:configure docker compose run --rm hat-app php bin/console hat:setup:db --init docker compose run --rm hat-app php bin/console hat:user:create ``` `hat:user:create` is required only for `simple` auth mode. #### 5. Start container [](#5-start-container) ``` docker compose up -d ``` #### 6. Open application [](#6-open-application) Open: `http://localhost:8080` ### Option 2: Clone full project (development/local workflow) [](#option-2-clone-full-project-developmentlocal-workflow) #### 1. Clone repository [](#1-clone-repository) ``` 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. Run setup commands locally [](#3-run-setup-commands-locally) ``` php bin/console hat:setup:configure php bin/console hat:setup:db --init php bin/console hat:user:create # Required only for `simple` auth mode ``` #### 4. Start an application with an GHCR image [](#4-start-an-application-with-an-ghcr-image) ``` docker compose pull docker compose up -d ``` #### 5. Or run development compose with local build and Xdebug [](#5-or-run-development-compose-with-local-build-and-xdebug) ``` docker compose -f docker-compose.dev.yml up -d --build ``` For local non-docker CLI workflow (optional): ``` 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 88% of packages Maintenance85 Actively maintained with recent releases Popularity2 Limited adoption so far Community7 Small or concentrated contributor base Maturity65 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 ~16 days Recently: every ~0 days Total 33 Last Release 76d ago Major Versions 1.x-dev โ†’ 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 (64 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.8k9.0k1](/packages/kimai-kimai)[oro/platform Business Application Platform (BAP) 645143.5k115](/packages/oro-platform)[rcsofttech/audit-trail-bundle Enterprise-grade, high-performance Symfony audit trail bundle. Automatically track Doctrine entity changes with split-phase architecture, multiple transports (HTTP, Queue, Doctrine), and sensitive data masking. 1189.8k](/packages/rcsofttech-audit-trail-bundle)[forumify/forumify-platform 122.0k14](/packages/forumify-forumify-platform)[shopware/core Shopware platform is the core for all Shopware ecommerce products. 585.6M576](/packages/shopware-core)[open-dxp/opendxp Content & Product Management Framework (CMS/PIM) 9421.6k61](/packages/open-dxp-opendxp) PHPackages ยฉ 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)