The usual way to work with Assegai is through the CLI.
If you are completely new to the framework, this is the best place to start. Once the assegai command works in your shell, the rest of the getting started guides become much easier to follow.
Assegai CLI is currently intended for:
- macOS
- Linux
- Windows through WSL
Native Windows support has not been fully verified yet, so the recommended Windows path today is WSL.
Install with Composer
Install the CLI globally with Composer:
composer global require assegaiphp/consoleOnce that finishes, you should have an assegai binary inside Composer's global package installation.
Put assegai on your path
There are two common ways to make the CLI available everywhere.
Option 1: add the Composer global bin directory to PATH
If you already manage a Composer global bin path in your shell profile, add that directory to PATH and reload your shell.
Option 2: create a symlink
You can also create a symbolic link from the installed binary to a standard system bin directory such as /usr/local/bin.
The important part is that the source should be the installed assegai binary, for example:
sudo ln -s /path/to/composer/global/vendor/assegaiphp/console/bin/assegai /usr/local/bin/assegaiAfter that, verify the command is available:
assegaiEnable shell completion
The CLI also ships with completion support. To see the available setup instructions, run:
assegai completion --helpThat command explains how to enable completion for your shell.
Next step
Once assegai is available on your path, continue with Getting Started to create your first project.