PHPackages jonytonet/ptah - 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. [Framework](/categories/framework) 4. / 5. jonytonet/ptah ActiveLibrary[Framework](/categories/framework) jonytonet/ptah ============== Ptah — Laravel scaffolding generator. CRUD, DTOs, Repositories, Services, Livewire 4, Tailwind v4. 26PHPCI failing Since Feb 24Pushed 2d agoCompare [ Source](https://github.com/jonytonet/ptah)[ Packagist](https://packagist.org/packages/jonytonet/ptah)[ RSS](/packages/jonytonet-ptah/feed)WikiDiscussions main Synced 3w ago READMEChangelogDependenciesVersions (2)Used By (0) [![Ptah — Enterprise Structure. Startup Speed.](docs/logo.png)](docs/logo.png)### Enterprise Structure. Startup Speed. [](#enterprise-structure-startup-speed) Generate your system's entire structure in minutes — you focus only on the business logic. Built for AI agents: the architecture comes ready, so the agent spends a fraction of the tokens. [![PHP Version](https://camo.githubusercontent.com/187240af044d09d5b14a1d9d9ebdf3f7a993e4c7bc09bdb46b4ba661a891bf5b/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d382e322532422d626c7565)](https://php.net)[![Laravel Version](https://camo.githubusercontent.com/88ce7f9ac798288a91de4918224da3cf354ffc092c40118a331bb5fa3c59f968/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c61726176656c2d3131253230253743253230313225323025374325323031332d726564)](https://laravel.com)[![Livewire Version](https://camo.githubusercontent.com/974504273b2cc96ef8e748351d4fac298b4e6381f7931808f9a1fe3784a5c0c2/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c697665776972652d342d626c756576696f6c65742e737667)](https://livewire.laravel.com)[![Tailwind CSS](https://camo.githubusercontent.com/8d3b1e3555ed2268a78a49d2492dd75ae92d85d543da305594b2f70dbadfebff/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5461696c77696e642d76342d303662366434)](https://tailwindcss.com)[![License: MIT](https://camo.githubusercontent.com/fdf2982b9f5d7489dcf44570e714e3a15fce6253e0cc6b5aa61a075aac2ff71b/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d4d49542d79656c6c6f772e737667)](LICENSE) --- What is Ptah? ------------- [](#what-is-ptah) **Ptah** is a Laravel package that combines SOLID scaffolding, ready-made visual components and a dynamic CRUD system in a single installation. With one command you generate the entire structure of an entity — model, migration, DTO, repository, service, controller, requests, resource, Livewire view and routes — ready to use from the very first `php artisan serve`. PillarWhat it delivers**Ptah Forge**26 Blade components (``) with Tailwind v4 + Alpine.js — layout, sidebar, navbar, modal, table, forms and much more**ptah:forge**SOLID scaffolding generator: an entire entity in seconds, with layered architecture and customisable stubs**BaseCrud**Fully generated Livewire screen — filters, create/edit modal, soft delete, export and per-user preferences, all configurable via the database--- > **In a hurry?** Follow the **[Quick Start →](docs/QuickStart.md)** — one entity, SQLite, working CRUD in 5 minutes. ⚡ The full structure in minutes — far fewer tokens with AI ---------------------------------------------------------- [](#-the-full-structure-in-minutes--far-fewer-tokens-with-ai) > **What Ptah generates in minutes:** the complete, layered structure of every entity (model, migration, DTO, repository, service, controller, requests, resource, Livewire screen and routes), plus auth, RBAC and a dynamic menu. **What stays with you:** the specific business logic and a short post-scaffold review (see [Known Limitations](docs/KnownLimitations.md)). > > **Why this saves tokens:** with **ptah + AI** (GitHub Copilot, Claude, Cursor) the agent doesn't waste tokens generating dozens of boilerplate files and re-deciding the architecture on every entity — that's already delivered, consistently. The agent spends its budget only on your differentiator. Fewer tokens, fewer files to review, and an architecture that doesn't drift between entities. ### Example: IT Helpdesk — full CRUD structure in ~3 minutes [](#example-it-helpdesk--full-crud-structure-in-3-minutes) #### Step 0 — Check system requirements [](#step-0--check-system-requirements) Before you start, confirm your environment meets the minimum versions: ``` php -v # Required: PHP 8.2+ composer -V # Required: Composer 2+ node -v # Required: Node.js 18+ npm -v # Required: npm 9+ ``` Expected output (example): ``` PHP 8.2.x ... Composer version 2.x.x ... v20.x.x 10.x.x ``` > If any version is below the minimum, update it before proceeding. See the [full requirements →](docs/InstallationGuide.md#requirements) for database and extension requirements. --- #### Step 1 — Create the Laravel project [](#step-1--create-the-laravel-project) ``` composer create-project laravel/laravel ptah-app cd ptah-app ``` --- #### Step 2 — Install Ptah [](#step-2--install-ptah) Choose **one** of the two options below: **Option A — From Packagist (stable — recommended):** ``` composer require jonytonet/ptah ``` **Option B — From GitHub (latest dev version):** Add the VCS repository to your `composer.json` before requiring the package: ``` { "repositories": [ { "type": "vcs", "url": "https://github.com/jonytonet/ptah" } ], "minimum-stability": "dev", "prefer-stable": true } ``` Then run: ``` composer require jonytonet/ptah:dev-main ``` **Both options — finish the installation:** ``` php artisan ptah:install ``` --- #### Step 3 — Configure your database [](#step-3--configure-your-database) Edit `.env` to point to your database of choice before running migrations. **SQLite** *(quick start)*: ``` DB_CONNECTION=sqlite ``` ``` touch database/database.sqlite ``` **MySQL**: ``` DB_CONNECTION=mysql DB_HOST=127.0.0.1 DB_PORT=3306 DB_DATABASE=ptah_app DB_USERNAME=root DB_PASSWORD=your_password ``` **PostgreSQL**: ``` DB_CONNECTION=pgsql DB_HOST=127.0.0.1 DB_PORT=5432 DB_DATABASE=ptah_app DB_USERNAME=postgres DB_PASSWORD=your_password ``` > See the [full database guide →](docs/InstallationGuide.md#step-3--configure-the-environment) for more options. --- #### Step 4 — Enable the required modules [](#step-4--enable-the-required-modules) ``` php artisan ptah:module auth php artisan ptah:module permissions php artisan ptah:module menu ``` --- #### Step 5 — Generate the 3 system entities [](#step-5--generate-the-3-system-entities) **Category:** ``` php artisan ptah:forge Category --fields="name:string,color:string:nullable,description:text:nullable" ``` **Agent:** ``` php artisan ptah:forge Agent --fields="name:string,email:string,department_id:unsignedBigInteger:nullable" ``` **Ticket:** ``` php artisan ptah:forge Ticket --fields="title:string,description:text,status:string,priority:string,category_id:unsignedBigInteger,agent_id:unsignedBigInteger:nullable,resolved_at:datetime:nullable" ``` --- #### Step 6 — Run migrations, sync menu and serve [](#step-6--run-migrations-sync-menu-and-serve) ``` php artisan migrate php artisan ptah:menu-sync --fresh php artisan serve ``` **What you get at the end (the structure):** - ✅ Login with session protection and 2FA - ✅ Full CRUD for Categories, Agents and Tickets — table, filters, modal, soft delete, export - ✅ Role-based access control (MASTER + custom roles) - ✅ Dynamic sidebar menu - ✅ SOLID architecture: Controller → Service → Repository → DTO - ✅ Generated validations, Resources and RESTful routes - ✅ 14 artefacts created per entity, zero manual boilerplate **What's still yours to do** (the actual application): wire up relationships left as TODOs, review the generated validation rules, and add the business logic — ticket escalation, priority notifications, integrations. Then the usual road to production: tests, security review and deploy. See the [post-scaffold checklist](docs/KnownLimitations.md). **Why AI loves this:** instead of generating hundreds of files — thousands of tokens, with architectural drift between entities — the agent runs the commands above and spends its token budget only on your differentiator. Ptah handles the structure; AI handles the business logic. --- 🚀 Installation -------------- [](#-installation) ### From Packagist (stable — recommended) [](#from-packagist-stable--recommended) ``` # 1. Install the package composer require jonytonet/ptah # 2. Run the installer php artisan ptah:install # 3. (Optional) Install Laravel Boost for AI agent integration php artisan ptah:install --boost ``` ### From GitHub (latest dev version) [](#from-github-latest-dev-version) Add to your `composer.json` before requiring: ``` { "repositories": [ { "type": "vcs", "url": "https://github.com/jonytonet/ptah" } ], "minimum-stability": "dev", "prefer-stable": true } ``` Then: ``` composer require jonytonet/ptah:dev-main php artisan ptah:install ``` > See the **[full installation guide →](docs/InstallationGuide.md)** for database setup, optional modules and troubleshooting. --- 🧩 Optional modules ------------------ [](#-optional-modules) Enable only what you need. Each module updates `.env` and runs its own migrations. ModuleCommandWhat it enables**auth**`php artisan ptah:module auth`Login, logout, password recovery, 2FA (TOTP + email), profile, active sessions**menu**`php artisan ptah:module menu`Dynamic sidebar menu via database with cache, accordion groups**company**`php artisan ptah:module company`Company and department management, company switcher, multi-tenant support**permissions**`php artisan ptah:module permissions`Full RBAC — roles, pages, objects, middleware, Blade directives, audit log**api**`php artisan ptah:module api`REST API with Swagger/OpenAPI via `darkaonline/l5-swagger`, standardised `BaseResponse`**ai\_agent**`php artisan ptah:module ai_agent`Floating AI chat widget (JivoChat-style) + provider config admin — powered by `prism-php/prism```` # Check current state of all modules php artisan ptah:module --list ``` --- 🤖 Ptah + AI ----------- [](#-ptah--ai) Ptah is designed to work with AI agents. When installed with `--boost`, the package automatically registers its guidelines in the configured agents (GitHub Copilot, Claude, Cursor, Gemini, etc.), giving the agent deep knowledge of Ptah conventions, commands and architecture. **Why this matters:** - **Without Ptah:** AI needs to generate model + migration + repository + service + controller + requests + resource + view + routes for each entity — dozens of files, thousands of tokens, high risk of inconsistency - **With Ptah:** AI runs `ptah:forge MyEntity --fields="..."`, the structure is ready, and it spends its tokens only on the business logic — fewer tokens, architecture guaranteed by the package > For prompts, templates and AI workflow, see the **[AI Guide →](docs/AI_Guide.md)** --- 📟 Commands ---------- [](#-commands) CommandDescription`php artisan ptah:install`Installs the package (config, stubs, migrations, default data). Flags: `--demo`, `--boost`, `--force`, `--skip-npm``php artisan ptah:forge {Entity}`**Generates the complete structure for an entity** ⭐`php artisan ptah:module {module}`Enables an optional module`php artisan ptah:module --list`Lists modules and their states`php artisan ptah:docs {Entity}`Generates Swagger/OpenAPI annotations--- 🎨 Theming & customizing views --------------------------------- [](#-theming--customizing-views) **Brand colors — set once, everything follows.** Define your palette in `config/ptah.php` (or via `.env`) and the whole UI — BaseCrud, Forge components, modules — picks it up. No view publishing, survives `composer update`: ``` // config/ptah.php 'theme' => [ 'colors' => [ 'primary' => env('PTAH_COLOR_PRIMARY', '#5b21b6'), 'success' => env('PTAH_COLOR_SUCCESS', '#10b981'), 'danger' => env('PTAH_COLOR_DANGER', '#ef4444'), 'warn' => env('PTAH_COLOR_WARN', '#f59e0b'), 'dark' => env('PTAH_COLOR_DARK', '#1e293b'), ], ], ``` ``` # .env — rebrand without touching code PTAH_COLOR_PRIMARY=#0d9488 ``` Ptah injects these as CSS variables (`--color-primary`, `--ptah-primary`, …) in the layout ``; every tint, focus ring and hover is derived from them via `color-mix()`. Accepts any CSS color (hex, rgb, hsl, oklch). **Customizing views — publish only what you edit.** Most customization is done through the CrudConfig modal (database-driven), so you rarely need to touch a Blade file. If you do, ⚠️ **publishing a view means you own it** — Laravel will prefer your copy and `composer update` will never refresh it again. Publish the **smallest** slice: ``` php artisan vendor:publish --tag=ptah-views-components # just the php artisan vendor:publish --tag=ptah-views-base-crud # just the BaseCrud screen php artisan vendor:publish --tag=ptah-views-auth # just the auth pages php artisan vendor:publish --tag=ptah-views-ai # just the AI widget # (ptah-views still publishes ALL 60+ views — avoid it unless you really mean to) ``` To keep the UI always up to date, keep `resources/views/vendor/ptah/` empty. --- 📚 Documentation --------------- [](#-documentation) DocumentContents**[Quick Start](docs/QuickStart.md)**Your first CRUD in 5 minutes — one entity, SQLite, zero decisions**[Installation Guide](docs/InstallationGuide.md)**Step-by-step guide with real terminal output — Laravel 11/12, all modules and Boost**[BaseCrud](docs/BaseCrud.md)**Complete reference — column schema, types, filters, renderers, export, preferences and UI configuration**[Modules](docs/Modules.md)**Detailed documentation for Auth, Menu, Company, Permissions and API modules**[Company](docs/Company.md)**Company module — companies, departments, company switcher and multi-company**[Permissions](docs/Permissions.md)**Permissions module — RBAC, roles, middleware, helpers, Blade directives and audit log**[Base Layer](docs/BaseLayer.md)**BaseDTO, BaseRepository, BaseService — all methods, signatures, examples and REST API query parameters**[AI Guide](docs/AI_Guide.md)**AI agent integration — prompts, templates and workflow with Copilot, Claude and Cursor**[Known Limitations](docs/KnownLimitations.md)**Developer checklist — decimal precision, FK constraints, composite indexes, post-forge responsibilities--- 📋 Requirements -------------- [](#-requirements) RequirementMinimum versionPHP8.2Laravel11, 12 or 13Node.js + npm18+Livewirev4 (included as dependency)--- 📄 License --------- [](#-license) Open source under the [MIT License](LICENSE). --- Made by [jonytonet](https://github.com/jonytonet) *Ptah — Enterprise Structure. Startup Speed.* ### Health Score 24 — LowBetter than 31% of packages Maintenance65 Regular maintenance activity Popularity7 Limited adoption so far Community8 Small or concentrated contributor base Maturity14 Early-stage or recently created project Bus Factor1 Top contributor holds 98.9% 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. ### Community Maintainers ![](https://www.gravatar.com/avatar/f094b98422767c3a77e97d569998cdb18678813ca853e81192e0d62891e0578b?d=identicon)[jonytonet](/maintainers/jonytonet) --- Top Contributors [![jonytonet](https://avatars.githubusercontent.com/u/71824976?v=4)](https://github.com/jonytonet "jonytonet (266 commits)")[![Copilot](https://avatars.githubusercontent.com/in/1143301?v=4)](https://github.com/Copilot "Copilot (3 commits)") ### Embed Badge ![Health badge](/badges/jonytonet-ptah/health.svg) ``` [![Health](https://phpackages.com/badges/jonytonet-ptah/health.svg)](https://phpackages.com/packages/jonytonet-ptah) ``` ### Alternatives [laravel/socialite Laravel wrapper around OAuth 1 & OAuth 2 libraries. 5.7k104.3M831](/packages/laravel-socialite)[laravel/dusk Laravel Dusk provides simple end-to-end testing and browser automation. 1.9k38.6M289](/packages/laravel-dusk)[pinguo/php-msf Pinguo Micro Service Framework For PHP 1.7k4.2k](/packages/pinguo-php-msf)[nineinchnick/edatatables Grid widget for the Yii Framework, wrapper for the DataTables jQuery plugin 173.2k](/packages/nineinchnick-edatatables)[link-cloud/fast-hyperf LinkCloud Fast Hyperf 241.2k1](/packages/link-cloud-fast-hyperf) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)