Skip to content
drawfig edited this page Aug 13, 2026 · 9 revisions

mouse-php-logo-cropped

Welcome to the mouse-php Wiki

mouse-php is a lightweight, zero-dependency PHP framework designed to deliver an exceptional developer experience without the overhead of magic obfuscation. It strikes the perfect balance between robust tooling and architectural transparency, allowing you to build web applications and RESTful APIs quickly while maintaining full visibility into your code structure.


Philosophy

If you believe that unnecessary complexity is a sign of poor engineering, you are in the right place. mouse-php is built for developers who want absolute control over their environment. When something breaks, you won't have to dig through ten layers of abstracted classes to find out why; the logic is always front and center, prioritizing a clean, minimalist approach to application architecture.

However, lightweight and transparent doesn't have to mean a poor Developer Experience (DX). mouse-php proves that you don't need magic obfuscation to build quickly. By pairing a zero-dependency core with comprehensive, purpose-built dev tooling, you get the rapid workflow of modern scaffolding and hot-reloading while maintaining complete visibility into exactly how your code is running.


Core Features

  • Production-Ready Out of the Box: Zero boilerplate configuration required. Install, initialize, and start writing your business logic immediately.
  • Easy to learn: Built on standard PHP syntax and clean OOP principles—no complex abstraction layers to learn.
  • Lightning-Fast Deployments: Features a built-in deploy command via squeak to generate lightweight, distribution-ready application packages in seconds, complete with version rollback support.
  • Robust CLI Tooling (squeak): Includes a powerful companion CLI utility handling scaffolding, routing management, middleware registration, and application bootstrapping.

Eliminating the "F5" Fatigue

A standout feature of the mouse-php ecosystem is its integrated development server, which automatically reloads your application upon code changes. Initiated via squeak serve, this brings the rapid, hot-reloading iteration workflow popularized by the JS/Vite ecosystem directly to PHP development.


Getting Started

To get up and running with mouse-php, check out the quick start guide below, or dive directly into the documentation to understand the core concepts.

Documentation Directory

Architecture & Core

Tooling

Clone this wiki locally