Documentation

Quickstart

Initialisez une configuration, validez-la, puis lancez votre premier workspace Vectron.

1. Initialiser la configuration

vectron init

Cette commande écrit un vectron.toml minimal que vous pouvez adapter pour votre premier lancement. Si vous voulez l’exemple complet documenté, utilisez vectron init --example.

2. Valider la configuration

vectron check

check détecte les chemins invalides, les commandes vides, les templates de logs invalides, les configurations de readiness mal formées et les autres erreurs de configuration avant le démarrage.

3. Prévisualiser le plan de démarrage

vectron start --dry-run

Cette commande affiche le plan résolu sans lancer les processus.

4. Démarrer le workspace

vectron start

Quand stdout est attaché à un terminal compatible, Vectron démarre la TUI. Sinon, il bascule en sortie terminal classique.

5. Inspecter le workspace

vectron status
vectron logs --target web

Les commandes status et logs parlent au workspace en cours via l’endpoint de contrôle local enregistré dans .vectron/runtime.json.

6. Itérer sur la configuration

Prochaines étapes courantes:

  • ajouter d’autres [[process]]
  • définir port_env et les règles d’allocation de ports
  • définir un group et éventuellement des labels de démarrage
  • ajouter des probes de readiness
  • configurer des templates de logs pour JSON ou logfmt

Pour la plus petite configuration utile, continuez avec First vectron.toml.