Référence CLI

Référence CLI

Cette page est générée depuis la sortie réelle de php bin/niang (Commander::help()) par scripts/generate-cli-reference.php — jamais retapée à la main, pour qu'une commande ajoutée ou renommée ne puisse pas y manquer sans que le tableau ci-dessous devienne visiblement incomplet à la prochaine régénération.

Toutes les commandes

CommandeDescription
niang serve [host:port] Démarre le serveur de développement (défaut 127.0.0.1:8000)
niang make:controller <Nom> Génère un contrôleur dans app/Controllers
niang make:model <Nom> Génère un modèle dans app/Models
niang make:migration <nom> Génère une migration dans database/migrations
niang make:seeder <Nom> Génère un seeder dans database/seeders
niang migrate Applique les migrations en attente
niang migrate:rollback Annule le dernier lot de migrations
niang migrate:fresh Réinitialise la base et rejoue toutes les migrations
niang db:seed [Nom] Exécute DatabaseSeeder, ou le seeder indiqué
niang route:cache Compile routes/web.php dans storage/framework/routes.php
niang route:clear Supprime le cache de routes
niang route:list Liste toutes les routes déclarées
niang openapi [--output=f] [--prefix=/api] Décrit les routes de l'API au format OpenAPI 3 (public/openapi.json)
niang make:middleware <Nom> Génère un middleware dans app/Middleware
niang make:request <Nom> Génère une FormRequest dans app/Requests
niang tinker REPL interactif sur l'application
niang key:generate Génère une nouvelle APP_KEY dans .env
niang queue:work Traite les jobs différés en attente
niang queue:failed Liste les jobs qui ont épuisé leurs tentatives
niang queue:retry <id> Remet un job échoué en file, tentatives réinitialisées
niang queue:flush Supprime définitivement tous les jobs échoués
niang cache:clear Vide le cache applicatif
niang optimize Cache les routes + rappels de prod (opcache, autoload)
niang optimize:clear Supprime les caches de routes et de configuration
niang about Vue d'ensemble : versions, environnement, pilotes, caches
niang env Affiche l'environnement courant (APP_ENV)
niang cors:check [origine] Vérifie config/cors.php ; simule un préflight depuis une origine
niang make:notification <Nom> Génère une notification dans app/Notifications
niang tenancy:install Multi-locataire : migration de la table des locataires et étapes suivantes
niang new <nom> Crée un nouveau projet et y installe un thème de site (--type=<slug> pour éviter la question)
niang np:install Installe le raccourci global `np` (macOS, Linux, Windows)
niang config:cache Fige config/*.php (production uniquement)
niang config:clear Supprime le cache de configuration
niang doctor Diagnostique l'environnement (PHP, extensions, .env, DB, storage...)
niang health Vérifie l'état d'exécution (DB, cache, storage, queue) — même logique que GET /health
niang make:policy <Nom> Génère une policy dans app/Policies
niang make:job <Nom> Génère un job dans app/Jobs
niang make:event <Nom> Génère un événement dans app/Events
niang make:command <Nom> Génère une commande custom dans app/Console/Commands
niang make:test <Nom> Génère un test dans tests/Unit
niang schedule:run Lance les tâches planifiées dues (routes/schedule.php) — à appeler chaque minute par cron
niang schedule:list Liste les tâches planifiées et leur prochaine exécution
niang down [--retry=N] [--secret] Met le site en maintenance (503, sauf /up et /health)
niang up Sort du mode maintenance
niang theme:add <vendor/paquet> Installe un thème publié comme paquet Composer (extra.niangpro-theme)

--type= et NIANG_SITE_TYPE

Les seuls flags et variables d'environnement réellement lus par le CLI, en dehors des noms de commande et de leurs arguments positionnels :

Flag / variableCommandeEffet
--type=<slug>niang newChoisit le type de site sans poser la question interactive — voir Démarrage.
NIANG_SITE_TYPEniang new et composer create-projectMême effet que --type=, lu par SiteTypePrompt::resolve() si --type est absent.

Tout autre argument est positionnel (ex. le nom du modèle pour make:model, l'hôte:port pour serve) — aucune autre commande de ce framework n'accepte de flag --.

Commandes applicatives (make:command)

Au-delà des commandes intégrées ci-dessus, une application peut ajouter les siennes :

bash
./bin/niang make:command SendNewsletter
app/Console/Commands/SendNewsletterCommand.php

namespace App\Console\Commands;

use Niang\Core\Console\Command;

class SendNewsletterCommand extends Command
{
    /** Nom invoqué en CLI : niang mon:nom */
    public static string $signature = 'newsletter:send';

    public static string $description = 'Envoie la newsletter du jour';

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

Commander parcourt app/Console/Commands/*.php et compare $signature au nom tapé — sans correspondance, il retombe sur l'aide générale plutôt que d'afficher une erreur. ./bin/niang sans argument (l'aide, capturée ci-dessus) ne liste que les commandes du noyau : les commandes applicatives d'un projet n'apparaissent nulle part dans Commander::help(), donc jamais dans le tableau ci-dessus — à documenter séparément si votre projet en ajoute.

⏱ 6.51 ms 🗄 0 requête(s) SQL 🧠 4.00 MB ↩ 200