relman CLI: Utility & Global Flags

← Retour à la présentation des commandes de l’interface en ligne de commande relman

Utilitaires et indicateurs globaux

Complétion du shell

complétion bash

Affiche une fonction de complétion Bash pour relman (mots et indicateurs de commande/sous-commande – et non les valeurs des jetons en temps réel, car leur complétion impliquerait de contacter le serveur à chaque pression sur la touche Tab). Utilisez-la avec source <(relman completion bash), ou installez le résultat dans un répertoire de complétion Bash.

completion powershell

Idem, pour Register-ArgumentCompleter. Utilisez-le avec relman completion powershell | Out-String | Invoke-Expression, ou ajoutez-la à un script de profil PowerShell.

Indicateurs globaux

Ces options s’appliquent à toutes les commandes ci-dessus et doivent précéder le verbe, par exemple relman --domain de.release-manager.com --cert mycert.p12 list organizations.

--domain, --cert, --cert-password et --format peuvent également être définies via les variables d’environnement RELMAN_DOMAIN, RELMAN_CERT, RELMAN_CERT_PASSWORD et RELMAN_FORMAT : un indicateur sur la ligne de commande prévaut toujours sur la variable d’environnement correspondante.

Exemples

1. Installation de la complétion Bash

$ relman completion bash | head -6
_relman_completion()
{
local cur prev
COMPREPLY=()
cur="${COMP_WORDS[COMP_CWORD]}"
prev="${COMP_WORDS[COMP_CWORD-1]}"

$ source <(relman completion bash)

Cas particulier : cette fonction ne complète que les mots de commande/sous-commande et les options — jamais les valeurs des tokens actifs (un identifiant d’organisation, un identifiant de tâche, etc.), car cela impliquerait de contacter le serveur à chaque pression sur la touche Tab. Ajoutez le source <(...) à votre profil de shell pour que cette configuration soit conservée d’une session à l’autre ; si vous l’exécutez une seule fois, la complétion ne s’appliquera qu’aux commandes du shell actuel.

2. Changer de format de sortie

$ relman --format=json list organizations
[{"id":"o-4kNc8Q","name":"Example Corp"},{"id":"o-Rz91Wm","name":"Sandbox GmbH"}]

Cas particulier : tous les exemples figurant sur les autres pages utilisent le format par défaut YAML format optimisé pour la lisibilité, mais tous fonctionnent de la même manière avec --format=json/xml/plain — l’option s’applique de manière uniforme à toutes les commandes ; il n’est pas possible de la désactiver au cas par cas.

3. Absence d’un indicateur obligatoire

$ relman list organizations
Erreur : option obligatoire --cert manquante.

Cas particulier : il s’agit d’une erreur d’utilisation locale (code de sortie 2) : la requête n’atteint jamais le serveur, contrairement à une erreur HTTP 401 (certificat présenté mais rejeté par le serveur) qui n’apparaît qu’une seule fois --cert/-i désigne effectivement un fichier. Définissez RELMAN_DOMAIN/RELMAN_CERT une seule fois dans votre environnement pour éviter d’avoir à utiliser --domain/--cert à chaque invocation, comme le supposent tous les exemples présentés sur ces pages.