Configuration de la saisie automatique de commandes dans l’AWS CLI - AWS Command Line Interface
FonctionnementConfiguration de la saisie automatique des commandes sur Linux ou sur macOSConfiguration de la saisie automatique des commandes pour Windows

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Configuration de la saisie automatique de commandes dans l’AWS CLI

L’AWS Command Line Interface (AWS CLI) inclut une fonctionnalité de saisie automatique des commandes compatible Bash qui vous permet d’utiliser la touche de tabulation pour terminer une commande partiellement saisie. Sur la plupart des systèmes, vous devez la configurer manuellement.

Pour plus d’informations sur la fonctionnalité d’invite automatique de la version 2 de l’AWS CLI, consultez Activation et utilisation des invites de commande dans l’AWS CLI.

Fonctionnement

Lorsque vous saisissez partiellement une commande, un paramètre ou une option, la fonctionnalité de saisie automatiques des commandes complète automatiquement votre commande ou affiche une liste de commandes suggérées. Pour demander l’exécution d’une commande, vous devez entrer partiellement une commande et appuyer sur la touche de saisie automatique, généralement la touche de tabulation dans la plupart des shells.

Les exemples suivants montrent différentes façons d’utiliser la saisie automatique des commandes :

  • Saisissez partiellement une commande et appuyez sur Tab pour afficher une liste de commandes suggérées.

    $ aws dynamodb dTAB
delete-backup                        describe-global-table
delete-item                          describe-global-table-settings
delete-table                         describe-limits
describe-backup                      describe-table
describe-continuous-backups          describe-table-replica-auto-scaling
describe-contributor-insights        describe-time-to-live
describe-endpoints

  • Saisissez partiellement un paramètre et appuyez sur Tab pour afficher une liste de paramètres suggérés.

    $ aws dynamodb delete-table --TAB
--ca-bundle              --endpoint-url           --profile              
--cli-connect-timeout    --generate-cli-skeleton  --query                
--cli-input-json         --no-paginate            --region               
--cli-read-timeout       --no-sign-request        --table-name           
--color                  --no-verify-ssl          --version              
--debug                  --output

  • Saisissez un paramètre et appuyez sur Tab pour afficher une liste de valeurs de ressource suggérées. Cette fonctionnalité est uniquement disponible dans la version 2 de l’AWS CLI.

    $ aws dynamodb delete-table --table-name TAB
Table 1                  Table 2                  Table 3

Configuration de la saisie automatique des commandes sur Linux ou sur macOS

Pour configurer la saisie automatique de commandes sous Linux ou macOS, vous devez connaître le nom du shell que vous utilisez et l’emplacement du script aws_completer.

Note

La saisie automatique des commandes est automatiquement configurée et activée par défaut sur les instances Amazon EC2 qui exécutent Amazon Linux.

Vérification que le dossier de la fonctionnalité de saisie se trouve dans votre chemin

Pour que la fonctionnalité de saisie AWS fonctionne correctement, aws_completer doit se trouver dans le chemin de votre shell. La commande which peut vérifier si la fonctionnalité de saisie se trouve dans votre chemin.

$ which aws_completer
/usr/local/bin/aws_completer

Si la commande which ne trouve pas la fonctionnalité de saisie, suivez les étapes ci-dessous pour ajouter le dossier de cette fonctionnalité dans votre chemin.

Étape 1 : localiser la fonctionnalité de saisie AWS

L’emplacement de la fonctionnalité de saisie AWS peut varier selon la méthode d’installation utilisée.

  • Gestionnaire de package - Les programmes, tels que pip, yum, brew et apt-get, installent généralement la fonctionnalité de saisie AWS (ou un lien symbolique vers cette dernière) dans un emplacement standard.

    • Si vous avez utilisé pip sans le paramètre --user, le chemin par défaut est /usr/local/bin/aws_completer.

    • Si vous avez utilisé pip avec le paramètre --user, le chemin par défaut est /home/username/.local/bin/aws_completer.

  • Programme d’installation fourni : si vous avez utilisé le programme d’installation fourni, le chemin par défaut est /usr/local/bin/aws_completer.

Si tout le reste échoue, vous pouvez utiliser la commande find pour lancer une recherche de la fonctionnalité de saisie AWS sur l’intégralité du système de fichiers. 

$ find / -name aws_completer
/usr/local/bin/aws_completer

Étape 2 : identifier votre shell

Pour identifier le shell que vous utilisez, vous pouvez utiliser l’une des commandes suivantes.

  • echo $SHELL - Affiche le nom du fichier du programme du shell. Il correspond généralement au nom du shell que vous utilisez, sauf si vous avez lancé un autre shell après la connexion.

    $ echo $SHELL
/bin/bash

  • ps - Affiche les processus actifs pour l’utilisateur actuel. L’un d’eux est le shell.

    $ ps
  PID TTY          TIME CMD
 2148 pts/1    00:00:00 bash
 8756 pts/1    00:00:00 ps

Étape 3 : ajouter la fonctionnalité de saisie dans votre chemin

  1. Recherchez le script de profil de votre shell dans votre dossier utilisateur.

    $ ls -a ~/
.  ..  .bash_logout  .bash_profile  .bashrc  Desktop  Documents  Downloads

    • Bash : .bash_profile, .profile ou .bash_login

    • Zsh : .zshrc

    • Tcsh : .tcshrc, .cshrc ou .login

  2. Ajoutez une commande d’exportation à la fin de votre script de profil similaire à l’exemple suivant. Remplacez /usr/local/bin/ par le nom du dossier que vous avez découvert dans la section précédente.

    export PATH=/usr/local/bin/:$PATH

  3. Rechargez le profil dans la session en cours pour appliquer ces modifications. Remplacez .bash_profile par le nom du script de shell que vous avez découvert dans la première section.

    $ source ~/.bash_profile

Activer la saisie automatique de commandes

Après avoir confirmé que la fonctionnalité de saisie se trouve dans votre chemin, activez la saisie automatique des commandes en exécutant la commande appropriée pour le shell que vous utilisez. Vous pouvez ajouter la commande au profil de votre shell pour l’exécuter chaque fois que vous ouvrez un nouveau shell. Dans chaque commande, remplacez le chemin /usr/local/bin/ par celui qui se trouve sur votre système dans Vérification que le dossier de la fonctionnalité de saisie se trouve dans votre chemin.

  • bash : utilisez la commande intégrée complete.

    $ complete -C '/usr/local/bin/aws_completer' aws

    Ajoutez la commande précédente à ~/.bashrc pour l’exécuter chaque fois que vous ouvrez un nouveau shell. Votre ~/.bash_profile doit avoir pour source ~/.bashrc pour garantir que la commande est également exécutée dans les shells de connexion.

  • zsh : pour exécuter la saisie automatique des commandes, vous devez exécuter bashcompinit en ajoutant la ligne de chargement automatique suivante à la fin du script de votre profil ~/.zshrc.

    $ autoload bashcompinit && bashcompinit
$ autoload -Uz compinit && compinit

    Pour activer la saisie automatique des commandes, utilisez la commande intégrée complete.

    $ complete -C '/usr/local/bin/aws_completer' aws

    Ajoutez les commandes précédentes à ~/.zshrc pour les exécuter chaque fois que vous ouvrez un nouveau shell.

  • tcsh : la saisie automatique pour tcsh utilise un type de mot et un modèle pour définir le comportement de saisie automatique. 

    > complete aws 'p/*/`aws_completer`/'

    Ajoutez la commande précédente à ~/.tcshrc pour l’exécuter chaque fois que vous ouvrez un nouveau shell.

Une fois que vous avez activé la saisie automatique des commandes, Vérification de la saisie automatique des commandes fonctionne.

Vérification de la saisie automatique des commandes

Après avoir activé la saisie automatique des commandes, rechargez votre shell, saisissez une commande partielle, puis appuyez sur la touche de tabulation pour voir les commandes disponibles.

$ aws sTAB
s3              ses             sqs             sts             swf
s3api           sns             storagegateway  support

Configuration de la saisie automatique des commandes pour Windows

Note

Pour plus d’informations sur la façon dont PowerShell gère la saisie automatique des commandes, y compris ses différentes clés de saisie automatique, consultez about_TAB_Expansion dans Microsoft PowerShell Docs.

Pour activer la saisie automatique des commandes pour PowerShell sous Windows, procédez comme suit dans PowerShell.

  1. Ouvrez votre $PROFILE à l’aide de la commande suivante.

    PS C:\> Notepad $PROFILE

    Si vous n’avez pas de $PROFILE, suivez la procédure suivante pour en créer un.

    PS C:\> if (!(Test-Path -Path $PROFILE ))
{ New-Item -Type File -Path $PROFILE -Force }

    Pour plus d’informations sur les profils PowerShell, consultez How to Use Profiles in Windows PowerShell ISE sur le site web Microsoft Docs.

  2. Pour activer la saisie automatique des commandes, ajoutez le bloc de code suivant à votre profil, enregistrez puis fermez le fichier.

    Register-ArgumentCompleter -Native -CommandName aws -ScriptBlock {
    param($commandName, $wordToComplete, $cursorPosition)
        $env:COMP_LINE=$wordToComplete
        if ($env:COMP_LINE.Length -lt $cursorPosition){
            $env:COMP_LINE=$env:COMP_LINE + " "
        }
        $env:COMP_POINT=$cursorPosition
        aws_completer.exe | ForEach-Object {
            [System.Management.Automation.CompletionResult]::new($_, $_, 'ParameterValue', $_)
        }
        Remove-Item Env:\COMP_LINE     
        Remove-Item Env:\COMP_POINT  
}

  3. Après avoir activé la saisie automatique des commandes, rechargez votre shell, saisissez une commande partielle, puis appuyez sur la touche de tabulation pour parcourir les commandes disponibles.

    $ aws sTab
    $ aws s3

    Pour voir toutes les commandes disponibles pour la saisie automatique, entrez une command partielle et appuyez sur Ctrl + Espace.

    $ aws sCtrl + Space
s3              ses             sqs             sts             swf
s3api           sns             storagegateway  support