PHPackages                             icehawk/icehawk - 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. icehawk/icehawk

ActiveLibrary[Framework](/categories/framework)

icehawk/icehawk
===============

Lightweight PHP routing framework, respecting CQRS

v2.2.0(8y ago)6731.0k5[1 issues](https://github.com/icehawk/icehawk/issues)1MITPHPPHP >=7.0

Since Mar 30Pushed 3y ago8 watchersCompare

[ Source](https://github.com/icehawk/icehawk)[ Packagist](https://packagist.org/packages/icehawk/icehawk)[ RSS](/packages/icehawk-icehawk/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (1)Versions (52)Used By (1)

[![Join the chat at https://gitter.im/icehawk/icehawk](https://camo.githubusercontent.com/893674e8c13ee87ef163f3f7bc326eae800751ef5888a9df2c44b9b6ad01c826/68747470733a2f2f6261646765732e6769747465722e696d2f6963656861776b2f6963656861776b2e737667)](https://gitter.im/icehawk/icehawk?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)[![Build Status](https://camo.githubusercontent.com/4f58945c34ffd86cacd6f018f77ca96cc7a0f2b32b433910ebba7c647aa74b5c/68747470733a2f2f7472617669732d63692e6f72672f6963656861776b2f6963656861776b2e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/icehawk/icehawk)[![Coverage Status](https://camo.githubusercontent.com/2b7ae4b92251499d01da00ca9a7c45050cbbd429e7654326e2374a450de41771/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6769746875622f6963656861776b2f6963656861776b2f62616467652e7376673f6272616e63683d6d6173746572)](https://coveralls.io/github/icehawk/icehawk?branch=master)[![Latest Stable Version](https://camo.githubusercontent.com/f858b1a24ad2d6b1a08d069a80667ef079c8d9b04504362410f0babc06958ade/68747470733a2f2f706f7365722e707567782e6f72672f6963656861776b2f6963656861776b2f762f737461626c65)](https://packagist.org/packages/icehawk/icehawk)[![Total Downloads](https://camo.githubusercontent.com/8dc768ab5ec8ca4d8c3d2078cce87a917db58e9a1cf3c206b783fd31b0c1f95f/68747470733a2f2f706f7365722e707567782e6f72672f6963656861776b2f6963656861776b2f646f776e6c6f616473)](https://packagist.org/packages/icehawk/icehawk)[![Latest Unstable Version](https://camo.githubusercontent.com/454a95c5860a8b207aab26fd306475bcbe2c96e1c5c4e56db1f1faa35b45eb62/68747470733a2f2f706f7365722e707567782e6f72672f6963656861776b2f6963656861776b2f762f756e737461626c65)](https://packagist.org/packages/icehawk/icehawk)[![License](https://camo.githubusercontent.com/4f54aad6258ece9ffe0f7f9db7ff19825724a90244683bd5ac37ccebb4ce0ee7/68747470733a2f2f706f7365722e707567782e6f72672f6963656861776b2f6963656861776b2f6c6963656e7365)](https://packagist.org/packages/icehawk/icehawk)[![phpstan enabled](https://camo.githubusercontent.com/96cefcabfaf3777e8f933f973a7ea208f547fe88769e87f0579d1a83eea5e6b7/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7068707374616e2d656e61626c65642d677265656e2e737667)](https://github.com/phpstan/phpstan)

[![IceHawk Framework](https://camo.githubusercontent.com/fa32101fc112c08d4929e95df4e71bb95df786d722981a1e17053714680bcdd7/68747470733a2f2f6963656861776b2e6769746875622e696f2f696d616765732f4c6f676f2d466c79696e672d5461696c2d57686974652e706e67)](https://camo.githubusercontent.com/fa32101fc112c08d4929e95df4e71bb95df786d722981a1e17053714680bcdd7/68747470733a2f2f6963656861776b2e6769746875622e696f2f696d616765732f4c6f676f2d466c79696e672d5461696c2d57686974652e706e67)
==============================================================================================================================================================================================================================================================================================================================================================================================================================================================================

[](#)

Lightweight PHP routing framework, respecting CQRS.

Requirements
------------

[](#requirements)

- PHP >= 7.0
- [fileinfo extension](https://pecl.php.net/package/Fileinfo) for handling uploaded files correctly

**For development only:**

- [xdebug extension](https://pecl.php.net/package/Xdebug) for running the tests

Installation
------------

[](#installation)

```
composer require icehawk/icehawk:^2.1
```

or add to your `composer.json`:

```
{
	"require": {
		"icehawk/icehawk": "^2.1"
	}
}
```

Documentation
-------------

[](#documentation)

**A full documentation can be found on our website: [icehawk.github.io](https://icehawk.github.io/docs/icehawk.html)**

Quickstart (installer)
----------------------

[](#quickstart-installer)

We provide an installer package that creates a new IceHawk project for you. Simply run:

```
composer create-project -n icehawk/installer /path/to/new-project
```

Answer the questions of the interactive installer and you're good to go.

[**» Watch our short video and see how it works:** Install IceHawk framework in less than 2 minutes](https://youtu.be/ns62lw52AOU)

Quickstart (manual)
-------------------

[](#quickstart-manual)

### Step 0 - Create a basic composer.json

[](#step-0---create-a-basic-composerjson)

```
{
    "require": {
        "icehawk/icehawk": "^2.1"
    },
    "autoload": {
        "psr-4": {
            "YourVendor\\YourProject\\": "./"
        }
    }
}
```

Then run:

```
composer update
```

### Step 1 - Create a request handler

[](#step-1---create-a-request-handler)

```