Documentation

Référence CLI

Référence de l'interface en ligne de commande de Vectron.

Cette page documente le CLI utilisateur vectron. Les champs de configuration sont documentés dans la référence vectron.toml et la référence vectron.stack.toml.

Options globales

Les options globales peuvent être placées avant la sous-commande.

Option	Valeur	Défaut	Env	Notes
`--log-level`	niveau de tracing	Non défini	`VECTRON_LOG`	Exemples: `trace`, `debug`, `info`.
`--trace-subscriber`	`pretty`, `json`	`pretty`	Aucun	Contrôle le format de sortie du tracing.
`--man`	flag	`false`	Aucun	Imprime la page man roff sur stdout.

Commandes principales

Commande	Rôle
`vectron start`	Lance le workspace configuré au premier plan.
`vectron check`	Valide `vectron.toml`.
`vectron migrate`	Génère `vectron.toml` depuis des entrées legacy supportées comme `Procfile`.
`vectron init`	Écrit un nouveau `vectron.toml` dans le dossier courant.
`vectron status`	Interroge l’endpoint de contrôle local pour l’état courant.
`vectron restart <target>`	Redémarre un processus ou une instance via l’endpoint de contrôle.
`vectron logs`	Suit les logs via l’endpoint de contrôle.
`vectron doctor`	Diagnostique le support terminal et la configuration.
`vectron stack ...`	Échafaude et provisionne une stack locale depuis `vectron.stack.toml` sur macOS.
`vectron completions ...`	Génère ou installe les completions shell.

`vectron start`

vectron start charge ./vectron.toml, prépare le plan de processus, lance le superviseur, et utilise la TUI quand stdout est attaché à un terminal.

Pour le modèle clavier, les zones de focus et les contrôles interactifs, voir le guide Interface terminale.

Option	Valeur	Défaut	Env	Notes
`--quiet`	flag	`false`	Aucun	Limite la sortie aux éléments essentiels.
`--dry-run`	flag	`false`	Aucun	Affiche le plan de démarrage sans exécuter les hooks, créer de logs, écrire l’état runtime, ni lancer de processus.
`--alt-screen`	booléen	`true`	Aucun	Désactivation possible avec `--alt-screen=false` pour conserver la sortie après exit.
`--only-groups`	liste de groupes	`[]`	Aucun	Valeurs séparées par virgule ou option répétée. Lance les processus appartenant à au moins un groupe listé.
`--skip-groups`	liste de groupes	`[]`	Aucun	Valeurs séparées par virgule ou option répétée. Ignore les processus appartenant à au moins un groupe listé.
`--enable-groups`	liste de groupes	`[]`	Aucun	Valeurs séparées par virgule ou option répétée. Réactive les groupes listés dans `global.disabled_groups`.
`--only-labels`	liste de labels	`[]`	Aucun	Valeurs séparées par virgule ou option répétée. Lance les processus ayant au moins un label listé.
`--skip-labels`	liste de labels	`[]`	Aucun	Valeurs séparées par virgule ou option répétée. Ignore les processus ayant au moins un label listé.
`--enable-labels`	liste de labels	`[]`	Aucun	Valeurs séparées par virgule ou option répétée. Réactive les labels listés dans `global.disabled_labels`.
`--tui-metrics`	`on`, `off`	`on`	`VECTRON_TUI_METRICS`	Active les métriques CPU/RSS des processus dans la TUI.
`--tui-metrics-mode`	`auto`, `foreground`, `background`, `frozen`	`auto`	`VECTRON_TUI_METRICS_MODE`	Contrôle le comportement des métriques avec le focus terminal.
`--tui-metrics-interval`	durée	`1s`	`VECTRON_TUI_METRICS_INTERVAL`	Intervalle de rafraîchissement partiel au premier plan. Exemples: `500ms`, `1s`.
`--tui-metrics-full-scan-interval`	durée	`10s`	`VECTRON_TUI_METRICS_FULL_SCAN_INTERVAL`	Intervalle de scan complet au premier plan.
`--tui-metrics-background-interval`	durée	`20s`	`VECTRON_TUI_METRICS_BACKGROUND_INTERVAL`	Intervalle partiel en arrière-plan quand les événements de focus sont supportés.
`--tui-metrics-background-full-scan-interval`	durée	`120s`	`VECTRON_TUI_METRICS_BACKGROUND_FULL_SCAN_INTERVAL`	Intervalle de scan complet en arrière-plan quand les événements de focus sont supportés.

Les options de listes de groupes et labels acceptent des valeurs séparées par virgule ou des flags répétés:

vectron start --only-groups api,worker
vectron start --only-groups api --only-groups worker
vectron start --only-labels public,optional

vectron start --dry-run affiche la table de démarrage résolue, avec les métadonnées GROUP et LABELS des processus quand elles sont configurées, sans exécuter les hooks, créer de logs, écrire l’état runtime, ni lancer de processus.

`vectron check`

vectron check valide ./vectron.toml sans démarrer les processus.

Option	Valeur	Défaut	Env	Notes
`--enable-groups`	liste de groupes	`[]`	Aucun	Valeurs séparées par virgule ou option répétée. Valide avec certains groupes désactivés réactivés.
`--enable-labels`	liste de labels	`[]`	Aucun	Valeurs séparées par virgule ou option répétée. Valide avec certains labels désactivés réactivés.

`vectron migrate`

vectron migrate génère ./vectron.toml depuis des fichiers legacy supportés comme Procfile. La commande refuse d’écraser un vectron.toml existant.

Option	Valeur	Défaut	Env	Notes
Aucune	-	-	-	Cette commande n’a pas d’option spécifique.

`vectron init`

vectron init écrit un vectron.toml minimal dans le dossier courant. La commande refuse d’écraser un fichier existant. Utilisez --example pour écrire l’exemple complet intégré dans vectron.toml.

Option	Valeur	Défaut	Env	Notes
`--example`	flag	`false`	Aucun	Écrit l’exemple complet intégré au lieu de la configuration minimale.

`vectron status`

vectron status interroge le workspace en cours via le socket de contrôle.

Option	Valeur	Défaut	Env	Notes
Aucune	-	-	-	Cette commande n’a pas d’option spécifique.

`vectron restart`

vectron restart <target> redémarre un processus ou une instance via le socket de contrôle.

Argument	Valeur	Requis	Notes
`<target>`	nom de processus ou d’instance	Oui	Exemples: `web`, `web#1`.

`vectron logs`

vectron logs suit les logs via le socket de contrôle.

Option	Valeur	Défaut	Env	Notes
`--target`	processus ou instance	Non défini	Aucun	Exemples: `web`, `web#2`. Conflit avec `--process` et `--instance`.
`-p`, `--process`	nom de processus	Non défini	Aucun	Filtre un processus. Conflit avec `--target` et `--instance`.
`--instance`	nom d’instance	Non défini	Aucun	Exemple: `web#2`. Conflit avec `--target` et `--process`.
`--once`	flag	`false`	Aucun	Lit une fois sans suivre. Conflit avec `--follow`.
`--follow`	booléen	`true`	Aucun	Désactivation possible avec `--follow=false`. Conflit avec `--once`.
`--json`	flag	`false`	Aucun	Émet des lignes de logs NDJSON.

`vectron doctor`

vectron doctor rapporte les capacités terminal et TUI.

Option	Valeur	Défaut	Env	Notes
`--json`	flag	`false`	Aucun	Émet le rapport en JSON.

`vectron doctor tui`

vectron doctor tui lance un probe interactif des capacités terminal.

Option	Valeur	Défaut	Env	Notes
`--timeout`	durée	`10s`	Aucun	Durée du probe. Exemples: `500ms`, `10s`.
`--json`	flag	`false`	Aucun	Émet le résultat du probe en JSON.

`vectron stack`

Le mode stack est actuellement limité à macOS. Les IDs de plugins acceptés par les commandes stack sont listés dans la page plugins intégrés.

`vectron stack init`

vectron stack init écrit un vectron.stack.toml minimal. La commande refuse d’écraser un fichier existant. Utilisez --example pour écrire l’exemple stack complet intégré.

Option	Valeur	Défaut	Env	Notes
`--example`	flag	`false`	Aucun	Écrit l’exemple complet intégré de `vectron.stack.toml` et s’arrête.

`vectron stack provision`

vectron stack provision initialise .vectron_stack/, installe les dépendances, et génère vectron.toml depuis un vectron.stack.toml existant.

Option	Valeur	Défaut	Env	Notes
`--force`	flag	`false`	Aucun	Autorise la suppression d’un dossier `.vectron_stack/data` non vide.
`--dry-run`	flag	`false`	Aucun	Affiche le plan sans modifier le disque.
`--only`	liste de plugins	`[]`	Aucun	Valeurs séparées par virgule ou option répétée. Utilise seulement ces plugins avant ajout des dépendances implicites.
`--skip`	liste de plugins	`[]`	Aucun	Valeurs séparées par virgule ou option répétée. Retire ces plugins de la sélection.

`vectron stack check`

vectron stack check valide vectron.stack.toml et la configuration dérivée/générée sans effet de bord.

Option	Valeur	Défaut	Env	Notes
`--only`	liste de plugins	`[]`	Aucun	Valeurs séparées par virgule ou option répétée. Restreint la vérification aux plugins sélectionnés.
`--skip`	liste de plugins	`[]`	Aucun	Valeurs séparées par virgule ou option répétée. Retire les plugins sélectionnés de la vérification.

`vectron stack landing-ids`

vectron stack landing-ids imprime les IDs de liens disponibles pour nginx.landing.quick_links.

Option	Valeur	Défaut	Env	Notes
`--only`	liste de plugins	`[]`	Aucun	Valeurs séparées par virgule ou option répétée. Restreint la sortie aux plugins sélectionnés.
`--skip`	liste de plugins	`[]`	Aucun	Valeurs séparées par virgule ou option répétée. Retire les plugins sélectionnés de la sortie.

`vectron completions`

`vectron completions generate`

vectron completions generate imprime un script de completion sur stdout.

Option	Valeur	Défaut	Env	Notes
`--shell`	`bash`, `fish`, `zsh`	Requis	Aucun	Sélectionne le shell pour lequel générer les completions.

Les completions générées incluent la structure CLI statique et des valeurs dynamiques:

vectron restart <target> complète les noms de processus et d’instances.
vectron logs --target, --process et --instance complètent les cibles runtime/config.
Les flags de groupes/labels de vectron start et vectron check complètent les valeurs de vectron.toml.
vectron stack provision/check/landing-ids --only et --skip complètent les IDs de plugins intégrés.

Les candidates dynamiques de processus et d’instances utilisent d’abord le socket de contrôle quand Vectron tourne, puis retombent sur la config locale. Les candidates de groupes et labels viennent de la config locale. Les candidates de plugins viennent du catalogue stack intégré. Les flags de listes séparées par virgule complètent l’élément courant après la dernière virgule.

`vectron completions install`

vectron completions install installe un script de completion dans un dossier conventionnel.

Option	Valeur	Défaut	Env	Notes
`--shell`	`bash`, `fish`, `zsh`	Requis	Aucun	Sélectionne le shell pour lequel installer les completions.
`--dir`	chemin	Spécifique au shell	Aucun	Surcharge le dossier de destination.

Cibles de completion par défaut:

Shell	Fichier	Dossier par défaut
Bash	`vectron`	`$XDG_DATA_HOME/bash-completion/completions`, fallback `~/.local/share/bash-completion/completions`
Fish	`vectron.fish`	`$XDG_CONFIG_HOME/fish/completions`, fallback `~/.config/fish/completions`
Zsh	`_vectron`	`$XDG_DATA_HOME/zsh/site-functions`, fallback `~/.local/share/zsh/site-functions`