CLI reference

This page is generated from the actual output of php bin/niang (Commander::help()) by scripts/generate-cli-reference.php — never retyped by hand, so that a command that is added or renamed cannot go missing here without the table below becoming visibly incomplete at the next regeneration. The CLI itself speaks French; the descriptions below are translated from resources/data/cli-reference.en.php.

Every command

--type= and NIANG_SITE_TYPE

The only flags and environment variables actually read by the CLI, apart from the command names and their positional arguments:

Every other argument is positional (e.g. the model name for make:model, host:port for serve) — no other command of this framework accepts a -- flag.

Application commands (make:command)

Beyond the built-in commands above, an application can add its own:

./bin/niang make:command SendNewsletter

namespace App\Console\Commands;

use Niang\Core\Console\Command;

class SendNewsletterCommand extends Command
{
    /** Name invoked on the CLI: niang my:name */
    public static string $signature = 'newsletter:send';

    public static string $description = "Sends today's newsletter";

    public function handle(array $arguments): void
    {
        //
    }
}

Commander scans app/Console/Commands/*.php and compares $signature with the name typed — with no match, it falls back to the general help rather than printing an error. ./bin/niang with no argument (the help, captured above) only lists the core commands: a project's application commands appear nowhere in Commander::help(), and so never in the table above — document them separately if your project adds any.