README

The official starter application for the IshmaelPHP Framework.

Features

Module-First Architecture: Organized by business logic, not just technical layers.
Slim & Fast: No unnecessary bloat, just what you need to get started.
Developer Friendly: Built-in CLI tools and PHPStorm integration.

Installation

You can create a new project using Composer:

composer create-project ishmael/ishmaelphp-starter my-app

Getting Started

Configure Environment: Copy .env.example to .env and adjust your settings (database, etc.).
```
cp .env.example .env
```
Generate App Key:
```
php vendor/bin/ish key:generate
```
Run the Server:
```
php -S localhost:8080 -t public
```
Visit http://localhost:8080 in your browser.

Documentation

Comprehensive documentation for IshmaelPHP can be found in the Docs folder or online at ishmaelphp.org (coming soon).

MCP Server

IshmaelPHP has its own mcp server that can provide AI agents with additional information about the framework. If you are using an ide made by jetbrains it should be discovered automatically. Unfortunately this is not quite as straightforward for other ide's and you may need to do some additional configuration.

VS Code and Claude Dev / Roo Code If you are using extensions like Claude Dev (now Roo Code) or Cline in VS Code, they are heavy users of MCP. However, they do not use a jetbrains-mcp.json file. Instead, they typically rely on a global configuration file (usually located at %APPDATA%\Code\User\globalStorage\saoudrizwan.claude-dev\settings\cline_mcp_settings.json on Windows). Users have to manually add the server configuration there, or use the extension's UI to point to the php executable and the ish-mcp path.
GitHub Copilot As of now, GitHub Copilot does not have a native "plug-and-play" discovery mechanism for local MCP servers in the same way JetBrains or specialized Claude extensions do. While Microsoft is moving towards supporting more external "skills" and "extensions," there isn't a single JSON file you can drop into a project root today that will make Copilot automatically start using a local PHP-based MCP server.

`ide:setup-run-configs`

This tool automatically sets up IDE "Run Configurations," allowing you to execute ish commands directly from your IDE's interface.

Supported IDEs: PhpStorm (more coming soon).
Action: Generates .xml files in .idea/runConfigurations/ for common tasks like help, migrate, and make:module.
How to use: Ask your AI assistant to "Set up my IDE run configurations for Ishmael."

Be sure to consult the following documents in the guide section of the Docs.

Ai Collaboration
Ai Manifesto
Conventions

in the how-to section

Create a Module
Framing Questions

and in the reference/modules section

Rag Configuration

PhpStorm Integration

A plugin has been developed to integrate Ishmael with PhpStorm. This plugin automates the setup of run configurations for common tasks, making it easier to execute ish commands directly from PhpStorm. It adds a menu (Ishmael) to the main menu that provides access to all the Cli commands and a custom Tool window which, amongst other things, provides access to the documentation. The plugin and mcp server has been designed to work in parralel and provide a rich end user experience for end users of the IshmaelPhp framework.

Metric Testing

No formal metric tests are published for the Ishmael Php Framework. This is a deliberate choice because we believe that you should actively test framework metrics on your own hardware so that you can see exactly what you are getting.

The recomended starting point for you to explore metric testing the framework is here. This is a simple document repository but it will guide you on exactly what metric tests are and how you can test Ishmael Php if you so wish.

License

The IshmaelPHP Starter is open-sourced software licensed under the MIT license.

ishmael / ishmaelphp-starter

Maintainers

Package info

Statistics

Security