PHPackages                             assegaiphp/console - 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. [CLI & Console](/categories/cli)
4. /
5. assegaiphp/console

ActiveLibrary[CLI & Console](/categories/cli)

assegaiphp/console
==================

The Assegai CLI is a command-line interface tool that helps you to initialize, develop and maintain your Assegai applications.

0.4.7(1mo ago)042MITPHPPHP >=8.3CI passing

Since Jun 4Pushed 1mo ago1 watchersCompare

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

READMEChangelog (10)Dependencies (11)Versions (32)Used By (0)

 [![Assegai Logo](https://camo.githubusercontent.com/d7dab2658d76e460e31be249de2fe5d420f7a7237eb9f2a315f83123632a3b6c/68747470733a2f2f617373656761697068702e636f6d2f696d616765732f6c6f676f732f6c6f676f2d63726f707065642e706e67)](https://assegaiphp.com/)

 [![Latest release](https://camo.githubusercontent.com/821327d3658b3f1a0fbd63ff4df33302a2a7dc2d6dcabee5d6b8d8c36c72004c/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f617373656761697068702f636f6e736f6c653f646973706c61795f6e616d653d74616726736f72743d73656d766572267374796c653d666c61742d737175617265)](https://github.com/assegaiphp/console/releases) [![Tests](https://camo.githubusercontent.com/8ab1b91bfa425113b0e16639bbfa21a6f1ed45329f903cf3ad0f96ee4b16faae/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f617373656761697068702f636f6e736f6c652f7068702e796d6c3f6272616e63683d6d61696e266c6162656c3d7465737473267374796c653d666c61742d737175617265)](https://github.com/assegaiphp/console/actions/workflows/php.yml) [![PHP 8.3+](https://camo.githubusercontent.com/9bf67f86d575c87bf6c023686d5e5a831f629a94a3bac355486e709814df4648/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d382e332532422d3737374242343f7374796c653d666c61742d737175617265266c6f676f3d706870266c6f676f436f6c6f723d7768697465)](https://camo.githubusercontent.com/9bf67f86d575c87bf6c023686d5e5a831f629a94a3bac355486e709814df4648/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d382e332532422d3737374242343f7374796c653d666c61742d737175617265266c6f676f3d706870266c6f676f436f6c6f723d7768697465) [![License](https://camo.githubusercontent.com/af49ed28bd1769f5fd25c45bd7ce1fa1d7cbde38f33659dec418fe4ce30986d4/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f617373656761697068702f636f6e736f6c653f7374796c653d666c61742d737175617265)](https://github.com/assegaiphp/console/blob/main/LICENSE) [![Status active](https://camo.githubusercontent.com/1214b36790042a591c22d285a8cbfdc3c33d1cbbbed099a0bca2f5edd79ca2a0/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7374617475732d6163746976652d3130623938313f7374796c653d666c61742d737175617265)](https://camo.githubusercontent.com/1214b36790042a591c22d285a8cbfdc3c33d1cbbbed099a0bca2f5edd79ca2a0/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7374617475732d6163746976652d3130623938313f7374796c653d666c61742d737175617265)

Assegai Console
===============

[](#assegai-console)

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

[](#requirements)

- PHP 8.3 (minimum)
- Composer 2.x.x

Description
-----------

[](#description)

The Assegai Console is the framework CLI for:

- creating new projects
- serving apps locally
- generating framework features
- exporting API contracts and clients
- working with queues, migrations, databases, and Web Components

It also supports custom schematics so teams can teach `assegai generate` about their own company-specific features.

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

[](#installation)

### Linux

[](#linux)

Install the Assegai Console globally using Composer:

```
$ composer global require assegaiphp/console
```

Create a symbolic link to the Assegai Console binary in a directory that is included in your system's `PATH` environment variable. For example, you can create a symbolic link in the `/usr/local/bin` directory:

```
$ sudo ln -s ~/.config/composer/vendor/bin/assegai /usr/local/bin/assegai
```

Alternatively, you can add the [Composer](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-macos) bin directory to your `$PATH` to make `assegai`available globally. To do so, add the following line to your shell configuration file (e.g., `~/.bashrc`, `~/.zshrc`, etc.):

```
$ export PATH="$PATH:$HOME/.config/composer/vendor/bin"
```

> **Note:** The path to the Composer bin directory may vary depending on your system configuration. Please refer to the [official Composer documentation](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-macos) for more information.

### Windows

[](#windows)

> **Note:** The following instructions are for Windows 10/11. If you are using an older version of Windows, please refer to the [official Composer documentation](https://getcomposer.org/doc/00-intro.md#installation-windows) for installation instructions.

For Windows, you can use WSL (Windows Subsystem for Linux) to install the Assegai Console. Follow the instructions for [Linux](#linux) above.

### macOS

[](#macos)

For macOS, you can use the same instructions as for [Linux](#linux).

Usage
-----

[](#usage)

### Get Started

[](#get-started)

To create a new Assegai project, run the following command:

```
$ assegai new my-app
```

This command will create a new Assegai project in the `my-app` directory.

### Development

[](#development)

After creating a new project, you can start the development server to preview your application in the browser.

```
$ cd my-app
```

To start the development server, navigate to the project directory and run the following command:

```
$ assegai serve
```

[![Assegai Serve](assets/images/screenshots/serve.png)](assets/images/screenshots/serve.png)

### OpenSwoole runtime

[](#openswoole-runtime)

If you want to try the long-lived runtime path instead of the default PHP development server, install the OpenSwoole extension first and then run:

```
$ assegai serve --runtime=openswoole
```

You can also persist that choice in `assegai.json`:

```
{
  "development": {
    "server": {
      "runtime": "openswoole",
      "host": "127.0.0.1",
      "port": 9510,
      "openswoole": {
        "workerNum": 1,
        "taskWorkerNum": 0,
        "maxRequest": 0,
        "enableCoroutine": true,
        "hookFlags": "all"
      }
    }
  }
}
```

If the extension is not installed, the CLI now stops early with a direct setup message instead of falling into a runtime bootstrap failure.

The current OpenSwoole path is still experimental. It is intended for careful testing and advanced runtime work, not as a blanket replacement for the default `php` runtime in every project.

Custom schematics
-----------------

[](#custom-schematics)

You can extend the generator without forking the CLI.

The default local convention is:

```
schematics//
  schematic.json
  templates/

```

Start with a declarative starter:

```
assegai schematic:init loyalty-program
```

Or scaffold a PHP-backed starter when generation needs real logic:

```
assegai schematic:init customer-portal --php
```

Inspect what the CLI discovered:

```
assegai schematic:list
```

Run a custom schematic through the normal generate workflow:

```
assegai g loyalty-program rewards
```

For reusable team schematics, package manifests can be exposed through `composer.json`:

```
{
  "extra": {
    "assegai": {
      "schematics": [
        "resources/loyalty/schematic.json"
      ]
    }
  }
}
```

Learn more in the [official documentation](https://assegaiphp.com/guide/getting-started/custom-cli-schematics).

Stay in touch
-------------

[](#stay-in-touch)

- Author - [Andrew Masiye](https://twitter.com/feenix11), [Daniel Kaluba](https://twitter.com/ZombieKlassic)
- Website - [https://atatusoft.com](https://atatusoft.com/)
- X - [@assegaiphp](https://twitter.com/assegaiphp)

License
-------

[](#license)

Assegai Console is [MIT Licensed](LICENSE)

###  Health Score

44

—

FairBetter than 92% of packages

Maintenance91

Actively maintained with recent releases

Popularity11

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity56

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 99.3% 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 ~23 days

Recently: every ~3 days

Total

29

Last Release

43d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/b56f1a86c97a44aa8b6e391bdfff3e41895f2262f6fd9295195806a068921e23?d=identicon)[amasiye](/maintainers/amasiye)

---

Top Contributors

[![amasiye](https://avatars.githubusercontent.com/u/5607605?v=4)](https://github.com/amasiye "amasiye (265 commits)")[![amasiyelr](https://avatars.githubusercontent.com/u/141437318?v=4)](https://github.com/amasiyelr "amasiyelr (2 commits)")

###  Code Quality

TestsPest

Static AnalysisPHPStan

Type Coverage Yes

### Embed Badge

![Health badge](/badges/assegaiphp-console/health.svg)

```
[![Health](https://phpackages.com/badges/assegaiphp-console/health.svg)](https://phpackages.com/packages/assegaiphp-console)
```

###  Alternatives

[illuminate/console

The Illuminate Console package.

12944.1M5.1k](/packages/illuminate-console)[crazywhalecc/static-php-cli

Build single static PHP binary, with PHP project together, with popular extensions included.

1.8k13.9k](/packages/crazywhalecc-static-php-cli)[statamic/cli

Statamic CLI Tool

7587.7k](/packages/statamic-cli)[shel/neos-terminal

Neos CMS Ui terminal for running Eel expressions and other commands

1441.3k](/packages/shel-neos-terminal)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)