argbash

argbash

• Écrivez-vous des scripts Bash qui devraient accepter les arguments?
• Mais ils ne sont pas les arguments que le support des arguments est une tâche intimidante, car ...
• getopt est découragé, getopts ne prend pas en charge les longues options, il n'y a pas de module Bash largement accepté pour effectuer la tâche et certaines solutions ne fonctionnent pas sur toutes les plateformes (Linux, OSX, MSW) ...

Essayez Argbash et arrêtez d'être terrorisé par ces arguments embêtants! Avec Argbash, vous obtiendrez:

• Déclaration rapide et minimaliste des arguments que votre script attend (voir ci-dessous pour les types d'arguments pris en charge).
• Les scripts générés à partir des définitions une fois qui peuvent être utilisés sur toutes les plates-formes qui ont bash .
• Définitions intégrées dans quelques lignes du script lui-même (vous pouvez donc utiliser Argbash pour régénérer facilement la partie analyse de votre script).
• Capacité à réutiliser les scripts Argbash - Aware en les emballant par des Argbash de niveau supérieur - Aware de plus commodément, sans duplication de code.
• Installation facile (facultative). Prenez simplement une version, dézip, allez à l'intérieur et exécutez cd resources && make install (vous voudrez peut-être exécuter sudo make install PREFIX=/usr pour une installation à l'échelle du système).
• Documentation et exemples.

Faites votre script existant alimenté par Argbash en quelques minutes. Explorez diverses saveurs d'argbash:

Saveur	Groupe cible
Argbash en ligne	Utilisez-le si vous souhaitez essayer Argbash sans l'installer et que vous avez un accès permanent à Internet.
Argbash Cli	Installez le package pour avoir argbash Ready localement tout le temps.
Argbash docker	Presque comme Argbash CLI, mais vous n'avez pas à l'installer, il vous suffit de télécharger l'image.

Ce que c'est

Argbash n'est pas une bibliothèque d'analyse, mais c'est plutôt un générateur de code qui génère une bibliothèque de bash-sur mesure pour votre script. Il vous permet de décrire les arguments que votre script devrait prendre, puis, vous pouvez générer le code d'analyse bash . Il reste dans votre script par défaut, mais vous pouvez le faire générer sur un fichier séparé et laisser Argbash pour l'inclure dans votre script pour vous. En tout cas, vous n'aurez pas besoin Argbash pour exécuter le script.

Argbash est très simple à utiliser et le code généré est relativement agréable à lire. De plus, les définitions d'arguments restent intégrées dans le script, donc lorsque vous devez mettre à jour la logique d'analyse, vous ne faites que relancer le script argbash sur le script déjà généré.

Ainsi, en écrivant quelques commentaires sur votre script et en exécutant le bin/argbash de Argbash dessus, vous obtiendrez un script bash avec l'analyse des arguments. Voir le modèle de source d'exemple simple et le script d'exemple simple pour le résultat. Si vous n'êtes pas à long terme, laissez bin/argbash-init générer le modèle pour vous.

Les types d'arguments suivants sont pris en charge:

• Arguments positionnels (par défaut pris en charge, possibilité de nombre fixe, variable ou infini d'arguments),
• Arguments facultatifs qui prennent une valeur,
• Arguments optionnels booléens,
• Arguments facultatifs répétés (c.-à-d.
• incrément (tel que --verbose ) arguments facultatifs et
• Action Arguments facultatifs (tels que --version , --help ).

Les sorties suivantes sont disponibles:

• Scripts bash, bibliothèques d'analyse de bash sur mesure.
• Les scripts POSIX qui utilisent getopts , également sur mesure.
• Achèvement de bash.
• Message d'utilisation conforme à Docopt.
• Sortie de la page manuelle à l'aide de RST2man.

L'utilité a été inspirée par argparse de Python et le projet shflags .

Lisez les documents (dernière version stable) pour plus d'informations

Exigences

• bash qui peut fonctionner avec des tableaux (très probablement bash >= 3.0 ) (la seule exigence pour les utilisateurs - c'est-à-dire des personnes qui ne font que des scripts et ne les font pas)
• Utilitaire autom4te qui peut fonctionner avec des ensembles (partie de autoconf >= 2.63 Suite)
• Les services publics de base sed , grep , cat , test .