Fichiers d'instructions
Si vous souhaitez utiliser le CLI de Stend comme moyen d'automatiser l'envoi d'un ou plusieurs fichiers, vous pouvez utiliser la sous-commande stend follow-instructions
suivie du chemin vers un fichier d'instruction valide.
Explication
Un fichier d'instruction est un fichier texte contenant une liste d'instructions à exécuter par le CLI de Stend. Chaque instruction est séparée par un retour à la ligne, les lignes vides sont ignorées.
Exemple :
# Options d'authentifications, celles de la configuration seront utilisées si elles ne sont pas définies ici
WEB_BASE_URL https://stend.example.com
API_BASE_URL https://stend-api.example.com
API_PASSWORD aaaaaaaaa
# Options de l'envoi, celles par défaut seront utilisées si elles ne sont pas définies ici
SILENT_OUTPUT true
EXPIRE_AFTER 5
DISABLE_NOTIFICATIONS true
DISABLE_SPINNER true
DISABLE_PROMPT false
DISABLE_AUTO_WRITE_CLIPBOARD true
DISABLE_HISTORY false
# Liste des fichiers, doit forcément être la dernière instruction
--- FILES
unexemple.txt
unexemple2.txt
Vous ne pouvez pas utiliser de commentaires dans un fichier d'instruction. Les lignes commençant par #
dans cet exemple ne servent qu'à expliquer le fonctionnement du fichier.
Erreurs à gérer
Le CLI peut afficher différentes erreurs, la liste est disponible ici :
Veuillez entrer le chemin d'un fichier d'instructions valide.
Impossible de suivre ce fichier d'instructions. Le fichier n'a pas pu être lu.
Impossible de suivre ce fichier d'instructions. Chargement des paramètres impossibles - API_BASE_URL manquant.
Impossible de suivre ce fichier d'instructions. Chargement des paramètres impossibles - EXPIRE_AFTER manquant.
Impossible de suivre ce fichier d'instructions. Chargement des paramètres impossibles - FILES manquant.
- Ainsi que les différentes erreurs pouvant être affichées lors d'un upload classique.
Liste d'instructions disponibles
Authentification
Les options non définies dans le fichier d'instruction seront récupérées depuis la configuration. Si l'URL de base de l'API est introuvable, une erreur sera renvoyée.
WEB_BASE_URL
(facultatif) : URL de base du client webAPI_BASE_URL
: URL de base de l'APIAPI_PASSWORD
(facultatif) : Mot de passe de l'API
Comportement
Ces options sont facultatives, à l'exception de
EXPIRE_AFTER
qui doit être définie.
SILENT_OUTPUT
: Indique au CLI d'afficher moins d'informationsEXPIRE_AFTER
: Durée de vie du fichier avant expiration (en minutes)DISABLE_NOTIFICATIONS
: Désactive les notifications à la fin de l'uploadDISABLE_SPINNER
: Remplace les barres de chargement par des objets JSONDISABLE_PROMPT
: Empêche le CLI de demander quoi que ce soit à l'utilisateurDISABLE_AUTO_WRITE_CLIPBOARD
: Désactive l'écriture de l'URL finale dans le presse-papierDISABLE_HISTORY
: Désactive l'ajout de l'URL finale dans l'historique
Liste de fichiers
Cette instruction doit être la dernière du fichier d'instruction. Les chemins des fichiers sont séparés par un retour à la ligne, et doivent être entrés après la ligne --- FILES
.