Référence CLI
La CLI Sovrium fournit deux commandes : démarrer un serveur de développement et générer un site statique. La configuration est chargée depuis un fichier ou une variable d'environnement.
Utilisation
La CLI accepte une commande suivie d'un chemin de fichier de configuration optionnel et d'options.
sovrium [command] [config] [flags] sovrium start app.yaml # Start dev server sovrium build app.yaml # Build static site sovrium --help # Show help
Commandes
Sovrium possède deux commandes. Si aucune commande n'est spécifiée, start est utilisée par défaut.
sovrium start
Démarre un serveur de développement qui sert votre application. C'est la commande par défaut — sovrium app.yaml est équivalent à sovrium start app.yaml.
sovrium start app.yaml
sovrium build
Génère un site statique à partir de votre configuration. Produit du HTML, du CSS et des ressources prêts pour le déploiement.
sovrium build app.yaml
sovrium --help
Affiche le message d'aide avec un résumé des commandes, options et exemples.
sovrium --help
Options
Les options peuvent être placées n'importe où dans la commande.
Sources de configuration
Sovrium peut charger la configuration depuis un fichier ou depuis la variable d'environnement APP_SCHEMA. Le fichier a la priorité lorsque les deux sont fournis.
Chemin de fichier
Passez un chemin vers un fichier JSON ou YAML comme deuxième argument.
sovrium start app.yaml sovrium build config.json
Variable d'environnement
Définissez la variable APP_SCHEMA pour fournir la configuration sans fichier. Supporte le JSON en ligne, le YAML en ligne ou une URL distante.
# Inline JSON
APP_SCHEMA='{"name":"my-app"}' sovrium start
# Inline YAML
APP_SCHEMA='name: my-app' sovrium start
# Remote URL
APP_SCHEMA='https://example.com/app.yaml' sovrium start
YAML ou JSON
Sovrium supporte les fichiers .yaml/.yml et .json. Le YAML est recommandé pour sa lisibilité.
Mode surveillance
Le mode surveillance surveille votre fichier de configuration et recharge automatiquement le serveur lorsque des modifications sont détectées.
# Start with file watching sovrium start app.yaml --watch # Edit app.yaml in another terminal... # Server reloads automatically
Récupération d'erreur
Si le fichier de configuration mis à jour est invalide, le rechargement échoue et le serveur précédent continue de fonctionner. Corrigez et sauvegardez pour réessayer.
Exemples
Cas d'utilisation courants de la CLI.
sovrium start
# Start from a JSON file sovrium start app.json # Start from a YAML file sovrium start app.yaml # Implicit start (default command) sovrium app.yaml # Start with watch mode (hot reload) sovrium start app.yaml --watch sovrium start app.yaml -w # Start on a custom port PORT=8080 sovrium start app.yaml
sovrium build
# Basic static build sovrium build app.yaml # Build for GitHub Pages SOVRIUM_DEPLOYMENT=github-pages sovrium build app.yaml # Build with sitemap and custom output SOVRIUM_OUTPUT_DIR=./public \ SOVRIUM_BASE_URL=https://example.com \ SOVRIUM_GENERATE_SITEMAP=true \ SOVRIUM_GENERATE_ROBOTS=true \ sovrium build app.yaml
Codes de sortie
La CLI utilise les codes de sortie standard.