Interface en ligne de commande

Chaque invocation de Mago suit le schéma mago [GLOBAL OPTIONS] <SUBCOMMAND>. Les options globales doivent venir avant la sous-commande.

mago --colors=never lint        # correct
mago lint --colors=never        # wrong, --colors is a global option

Options globales

Ces options s'appliquent à chaque sous-commande et contrôlent le runtime, la découverte de configuration et la sortie.

Drapeau	Description
`--workspace <PATH>`	Racine du workspace. Par défaut le répertoire courant.
`--config <PATH>`	Chemin du fichier de configuration. Sans cela, Mago cherche dans le workspace, `$XDG_CONFIG_HOME`, `~/.config` et `~`. Voir découverte.
`--php-version <VERSION>`	Surcharge la version PHP configurée, par exemple `8.2`.
`--threads <NUMBER>`	Surcharge le nombre de threads. Par défaut le nombre de CPUs logiques.
`--allow-unsupported-php-version`	Exécute contre une version PHP que Mago ne prend pas officiellement en charge. À utiliser avec précaution.
`--no-version-check`	Réduit au silence l'avertissement émis sur une divergence mineure ou patch par rapport à la version épinglée du projet. La divergence majeure reste fatale. Voir épinglage de version.
`--colors <WHEN>`	Quand colorer la sortie : `always`, `never` ou `auto` (par défaut).
`-h`, `--help`	Affiche l'aide et quitte.
`-V`, `--version`	Affiche la version installée et quitte.

Variables d'environnement

La plupart des surcharges de configuration utilisent le préfixe MAGO_* et sont documentées sur la page des variables d'environnement. Les deux que vous êtes le plus susceptible de définir au quotidien sont :

Variable	Rôle
`MAGO_LOG`	Filtre de log pour la sortie de tracing. Valeurs : `trace`, `debug`, `info`, `warn`, `error`.
`MAGO_EDITOR_URL`	Modèle d'URL pour les chemins de fichiers cliquables dans la sortie du terminal. Voir intégration éditeur.

Sous-commandes

Les outils principaux :

Commande	Description
`mago analyze`	Analyse statique : erreurs de type, bugs de logique.
`mago ast`	Affiche l'AST d'un fichier PHP.
`mago format`	Formate les fichiers PHP.
`mago guard`	Applique les règles et frontières architecturales.
`mago lint`	Linte pour le style, la justesse et les bonnes pratiques.

Commandes utilitaires :

Commande	Description
`mago config`	Affiche la configuration fusionnée ou son JSON Schema.
`mago init`	Génère un `mago.toml` de départ.
`mago list-files`	Liste les fichiers que Mago va traiter.
`mago generate-completions`	Affiche les scripts de complétion shell.
`mago self-update`	Remplace le binaire installé par une release plus récente.

Codes de sortie

Code	Signification
`0`	Succès. Aucun problème trouvé.
`1`	Problèmes trouvés nécessitant attention.
`2`	Erreur d'outil : configuration, I/O, échec d'analyse, etc.