LoginSignup
2
1

More than 1 year has passed since last update.

@hatahatahatainKDDI株式会社

初学者向けに AWS CLI のタブ補完の有効化手順を、かみ砕いて書いてみる（WindowsとLinuxどっちも）

Last updated at Posted at 2022-09-18

AWS CLIのタブ補完を有効化する手順はドキュメントに記載されていますが、初学者にはちょっと難しそうだなあと思いました
自分の勉強のためにも、コマンドの意味も補足しながらかみ砕いた手順を記載します

※AWS公式ドキュメントでは「コマンド補完」と記載されていますが、個人的には「タブ補完」のほうがなじみあるため、この記事では「タブ補完」と記載します

Linuxの場合の手順

パスにAWSコンプリータがあることを確認（なければ追加）

AWS公式ドキュメントに記載されている以下のコマンドによって、AWSコンプリータがパスにあるかどうかを確認できます

$ which aws_completer
/usr/local/bin/aws_completer

  • whichコマンドを使うことで、コマンドの実体がどこにあるのかを調べることができます。要するに、which <xxxxxx>と入力してパスが返ってくれば、パスが通っていると言えるのです

  • AWSコンプリータとは、awsコマンドでタブ補完を行うためのツールのようなものです。
    （ツールという表現が正しいかどうかはちょっと怪しいので、あくまでイメージと捉えてください）

もしパスが通っていない場合は、パスに追加する必要があるので以下の手順を踏みます

AWSコンプリータのファイルを探す

AWS CLIをインストールしていればどこかにAWSコンプリータも保存されているはず（？）なので、迷子のaws_completerを探します

公式ドキュメントは「まずはここを探してみなさい」とヒントをくれています

パッケージマネージャー - pip、yum、brew、および apt-get などのプログラムは通常、AWS コンプリータ (またはシンボリックリンク) を標準のパスの場所にインストールします。
pip を「--user」パラメータを指定せずにを使用した場合、デフォルトのパスは「/usr/local/bin/aws_completer」です。
pip を「--user」パラメータと共に使用した場合デフォルトのパスは「/home/username/.local/bin/aws_completer」です。
バンドルインストーラ - バンドルされたインストーラを使用した場合、デフォルトのパスは「/usr/local/bin/aws_completer」です。

それでも見つからない場合は、ファイル検索でaws_completerを探します
先ほどはwhichコマンドを使用しましたが、ファイル検索を行う場合はfindコマンドを使用します

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

使っているシェルが何か確認する

ファイルの場所がわかればパスを通すことができるので、まずは使っているシェルが何かを確認しましょう

$ echo $SHELL
/bin/bash

プロセスを確認することでも、シェルの特定ができます

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

AWSコンプリータをパスに追加する

ログインしているユーザーのホームディレクトリ（/home/ユーザー名）で、以下のコマンドを実行するとプロファイルスクリプトが確認できます

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

ドキュメントに記載されている例は、Bashを使っている場合の例ですね

  • プロファイルスクリプトとはLinuxにログインする度に実行されるスクリプトのことで、環境変数の定義などを記載するのが一般的。Bashの場合は.bash_profile、.profile、.bash_loginが該当する。

プロファイルスクリプトがわかったら、viなどのエディタでプロファイルスクリプトを開き、末尾に以下の文字列を追加します

export PATH=/usr/local/bin/:$PATH
※「/usr/local/bin/」の部分は、findで確認したAWSコンプリータのディレクトリパスを入力する

これは、もともとある$PATH変数に/usr/local/bin/というパスを追加するコマンドです

プロファイルスクリプトに追記したらエディタを閉じ、追記内容を反映させます

$ source ~/.bash_profile

これでaws_completerをパスに追加することができました

タブ補完を有効化する

aws_completerをパスに追加できれば、タブ補完を有効化するのは簡単です
（シェルの種類によって手順が異なりますが、ここではbashに限って記載します）

まずはホームディレクトリ内にある.bashrcをviなどのエディタで開きます
そして、以下の文字列を末尾に追加して上書き保存します

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

  • completeコマンドを使うことで、コマンドをどのように補完するかを定義することができます。上記のコマンドは、awsというコマンドを/usr/local/bin/aws_completer（AWSコンプリータ）に従って補完することを定義しています。

  • .bashrcとはbashコマンドを実行したときに読み込まれるファイルです。プロファイルスクリプトと似ていますが、読み込まれるタイミングが異なります。

.bashrcを書き換えたらシェルを再起動します
新しいターミナルを開いてもいいですし、source ~/.bashrcで変更を反映させてもよいと思います

これで晴れてタブ補完が使えるようになります！！

Windowsの場合の手順

利用するターミナルはPowerShellです

スクリプトの実行ポリシー変更

公式ドキュメントには記載されていませんが、まず最初にやらなくてはならないことがあります。
それはスクリプトの実行を有効化することです

PowerShellは、デフォルトでスクリプトファイルを実行することができない設定になっています
AWS CLIのタブ補完を有効化するためには$PROFILEに追記したスクリプトが実行される必要があります。しかし、デフォルトのままではポリシーに引っかかってしまいエラーになってしまいます。

なのでまずは、スクリプト実行のポリシーを変更するためにSet-ExecutionPolicyコマンドを実行します

Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy RemoteSigned

  • -Scopeオプションでポリシー変更の対象を選ぶことができます。現在のプロセスのみ、現在のユーザーのみ、すべてのユーザー、どれに対してポリシーの変更を実行するのかを設定します。

  • -ExecutionPolicyオプションで、何の実行ポリシーを設定するのかを選択できます。RemoteSignedは以下のような設定です。

インターネットからダウンロードしたすべてのスクリプトと構成ファイルが、信頼できる発行元によって署名されている必要があります。Windows サーバー コンピューターの既定の実行ポリシー。

PowerShellでこのシステムではスクリプトの実行が無効になっているため、ファイル hoge.ps1 を読み込むことができません。となったときの対応方法
https://qiita.com/ponsuke0531/items/4629626a3e84bcd9398f

ユーザープロファイルの存在を確認

ここからは、公式ドキュメントの通り進めていきます
まず、WindowsでAWS CLIのタブ補完を有効にするには、Windows PowerShell のユーザープロファイルにコードを追記する必要があります
なので、まずはユーザープロファイルをメモ帳で開きます

PS C:\> Notepad $PROFILE

  • ユーザープロファイルとは、Windowsのユーザーごとのデータや設定（デスクトップの画面設定など）のこと。C:\User\<ユーザー名>を見るとユーザーの保存データと設定データが確認できる。ここにはユーザーが保存したデータ（ダウンロード、ドキュメントなど）や、ユーザーごとの設定ファイル（NTUSERS.DATという名前のファイル）が保存されている。

  • PowerShell用のプロファイルも作成することができ、プロファイルのパスは$PROFILEで定義されています。Bashで言うと.bashrcのようなファイルですね。

    PowerShellの.bashrc的な設定ファイルこと$Profileについての紹介
    https://qiita.com/smicle/items/0ca4e6ae14ea92000d18

    Windows PowerShell Profiles | Microsoft Learn
    https://learn.microsoft.com/en-us/previous-versions/bb613488(v=vs.85)?redirectedfrom=MSDN

  • Notepadコマンドはファイルをメモ帳で開くことができるコマンドです。なので、Notepad $PROFILEを実行することでPowerShellのプロファイルをメモ帳で開いて編集することができます。

もし$PROFILEがない場合には、次のコマンドを実行してユーザープロファイルを作成できます

PS C:\> if (!(Test-Path -Path $PROFILE ))
{ New-Item -Type File -Path $PROFILE -Force }
  • 上記のコマンドは、まずTest-Pathで$PROFILEが存在するかどうかを確認しています。そして、存在しない場合にはNew-Itemで$PROFILEを作成します。

タブ補完を有効化するためのコードをプロファイルに追記

$PROFILEを開いたら、以下のコマンドを追記します

Register-ArgumentCompleter -Native -CommandName aws -ScriptBlock {
    param($commandName, $wordToComplete, $cursorPosition)
        $env:COMP_LINE=$wordToComplete
        $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  
}
  • Register-ArgumentCompleterコマンドは、タブ補完機能を新規登録することができるコマンドです。上記のコマンドでは、awsコマンドでタブ補完するために実行するスクリプトを-ScriptBlockに記載しています。

コードを追記したら上書き保存して、PowerShellを開きなおします。
そうすると、タブ補完が使用できるようになっています！！

ちなみに、PowerShellで補完できるコマンドの一覧を表示するにはCtrl + [Space] を押す必要があります

$ aws s[Ctrl + Space]
s3              ses             sqs             sts             swf
s3api           sns             storagegateway  support

参考資料

手前味噌ですが、AWS CLIタブ補完をWindowsで有効化したときの躓きポイントをまとめた記事を以前書きました

そもそもパスって何？って方はこちらを一読いただくことをお勧めします

.bashrcと.bash_profileの違いについては、このあたりの記事が参考になりそうです

2
1
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
Sign upLogin
2
1