[draft] aws_completer 설정

aws_completer 설정

aws_completer는 AWS CLI 명령어의 자동 완성 기능을 제공하는 도구입니다.

AWS CLI v2와 aws_completer를 설치하는 방법

1. AWS CLI v2 설치

AWS CLI v2는 공식 AWS CLI 설치 페이지(https://aws.amazon.com/cli/)에서 다운로드하여 설치할 수 있습니다. 설치 방법은 각 운영체제마다 다소 다를 수 있습니다. 설치 후에는 AWS CLI v2가 제대로 작동하는지 확인해보세요.

$ aws --version
aws-cli/1.29.25 Python/3.10.12 Linux/5.19.0-1024-aws botocore/1.31.25

$ which aws_completer
/usr/local/bin/aws_completer

2. aws_completer 설정

aws_completer를 설정하는 방법은 설치한 AWS CLI v2의 버전에 따라 달라질 수 있습니다.

 

Linux/macOS에서 bash를 사용하는 경우

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

Linux/macOS에서 zsh를 사용하는 경우

source /usr/local/bin/aws_zsh_completer.sh

위 예시에서 '/usr/local/bin/aws_completer' 또는 '/usr/local/bin/aws_zsh_completer.sh' 경로는 실제로 aws_completer 또는 aws_zsh_completer.sh 파일이 설치된 경로에 따라 달라질 수 있습니다. 환경에 맞게 경로를 수정하여 실행하시기 바랍니다.

 

이렇게 AWS CLI v2와 aws_completer를 설치하고 설정한 후, aws 명령어를 입력할 때 자동 완성 기능이 제대로 동작하는지 확인해보세요.

3. aws_completer 사용하는 방법

aws_completer를 사용하는 방법은 매우 간단합니다. AWS CLI 명령어를 입력하다가 자동 완성을 원하는 시점에서 키를 누르면 가능한 자동 완성 옵션들이 나타납니다.

 

자동 완성 기능 활용

AWS CLI 명령어를 입력하다가 키를 누르면 가능한 자동 완성 옵션들이 나타납니다. 예를 들어:

aws s3 <Tab>

$ aws s3
cp        ls        mb        mv        presign   rb        rm        sync      website

위와 같이 입력하면 s3 관련 명령어들의 자동 완성 옵션이 표시됩니다.

 

자동 완성 후 옵션 선택

자동 완성된 옵션 중에서 선택하려면 화살표 키 (위/아래)를 사용하여 옵션을 선택한 후 키를 누르면 해당 명령어가 자동으로 완성됩니다.

 

서브커맨드 자동 완성

aws 명령어의 서브커맨드도 자동 완성됩니다. 예를 들어:

aws ec2 <Tab>

$ aws ec2
Display all 593 possibilities? (y or n)
accept-address-transfer                                                   describe-placement-groups
accept-reserved-instances-exchange-quote                                  describe-prefix-lists
accept-transit-gateway-multicast-domain-associations                      describe-principal-id-format
accept-transit-gateway-peering-attachment                                 describe-public-ipv4-pools
accept-transit-gateway-vpc-attachment                                     describe-regions
accept-vpc-endpoint-connections                                           describe-replace-root-volume-tasks
accept-vpc-peering-connection                                             describe-reserved-instances
advertise-byoip-cidr                                                      describe-reserved-instances-listings
allocate-address                                                          describe-reserved-instances-modifications
allocate-hosts                                                            describe-reserved-instances-offerings
allocate-ipam-pool-cidr                                                   describe-route-tables
...

위와 같이 입력하면 ec2 관련 서브커맨드들의 자동 완성 옵션이 표시됩니다.

 

옵션 및 매개변수 자동 완성

명령어의 옵션과 매개변수도 자동 완성됩니다. 예를 들어:

aws ec2 describe-instances --<Tab>

$ aws ec2 describe-instances --
--ca-bundle              --debug                  --instance-ids           --no-verify-ssl          --region
--cli-connect-timeout    --dry-run                --max-items              --output                 --starting-token
--cli-input-json         --endpoint-url           --no-dry-run             --page-size              --version
--cli-read-timeout       --filters                --no-paginate            --profile
--color                  --generate-cli-skeleton  --no-sign-request        --query

위와 같이 입력하면 describe-instances 명령어의 옵션들이 자동 완성됩니다.

 

aws_completer를 통해 AWS CLI 명령어의 자동 완성 기능을 활용하면 명령어를 더 빠르고 정확하게 입력할 수 있습니다.

 

참고URL

- 명령 완성 : https://docs.aws.amazon.com/ko_kr/cli/latest/userguide/cli-configure-completion.html

- Linux 또는 macOS에서 명령 완성 구성 : https://docs.aws.amazon.com/ko_kr/cli/latest/userguide/cli-configure-completion.html#cli-command-completion-linux