aws q developer cliの基本操作と活用法を完全ガイド

目次

はじめに

概要

本ドキュメントは、Amazon Q Developer CLIに関する包括的な案内です。CLIは、コマンドラインで動作するAI開発アシスタントで、VS Codeの拡張と連携しながらローカル環境やAWSリソースにアクセスして開発支援を行います。本書ではCLIの概要、できること、導入手順、実際の利用例を丁寧に解説します。

対象読者

  • コマンドラインで開発を行うエンジニア
  • VS CodeなどのIDEと連携して作業したい開発者
  • ローカル環境やAWS上でAI機能を試したい方
    専門用語は必要最小限にし、具体例で補足しますので、CLI初心者でも理解しやすい構成です。

本書の使い方

各章は独立して読めますが、段階的に進めると理解が深まります。まず本章で全体像をつかみ、続く章で機能や導入手順、最後に実践例を試してください。

期待できる効果

  • 開発の生産性向上
  • ローカルとクラウド間のスムーズな連携
  • IDEとCLIを組み合わせた柔軟な開発ワークフロー

この後の章で、具体的な操作やコマンド例を順を追って説明します。

Amazon Q Developer CLIとは何か?

概要

Amazon Q Developer CLIは、ターミナル上で使えるAI開発アシスタントです。VS Code版と同じLLMベースの知能を持ち、IDEを開かずに普段使っている端末から直接利用できます。ローカルのファイルやコードベースへアクセスし、プロジェクト全体の文脈を理解して支援します。

主な特徴

  • コマンドラインで動作するため、キーボード中心の作業に向いています。
  • ローカルファイルへ直接アクセスできるので、実際のコードを読んで修正案を提示します。
  • MacOSや複数のLinuxディストリビューション向けに配布されます。

動作のイメージ

ターミナルで質問を投げると、Qがプロジェクト内の関連ファイルを参照して回答します。例えば、テストが失敗した箇所の原因を探したり、リファクタ提案を生成したりできます。

他のQとの違い

AWSコンソール版のQはクラウド中心の操作を補助しますが、CLIはローカルコードの理解と編集に強みがあります。端末で完結する開発ワークフローを好む方に適しています。

簡単なユースケース

  • 既存プロジェクトでバグ箇所を特定する
  • 新しい関数の実装案を対話的に作る
  • コードの一括リファクタ案を生成する

以上が本章の説明です。

Amazon Q Developer CLIでできること

概要

Amazon Q Developer CLIは、コマンドラインから自然言語で指示を与えつつ、プロジェクト全体や個別ファイルの文脈を深く理解して支援するツールです。対話形式で相談しながら作業を進められます。

主な機能

  • q chatで自然言語の指示を受け付け、コード修正や提案を行います。
  • ローカルファイルや複数ファイルにまたがるリファクタリングを自動で提案・実行します。
  • 設定ファイル(例:package.json、Dockerfile、CI設定)の修正や改善案を提示します。
  • テスト生成やバグ修正の提案、パッチ適用を行います。

AWS連携

  • ローカルのAWS CLI設定を活用して、アカウント情報やリソース状況を把握できます。
  • IAMポリシーやインフラ構成の改善案を提示し、必要な変更を分かりやすく示します。例:最小権限のポリシー案やS3設定の注意点。

外部ツール連携(MCP)

  • MCP経由で外部APIやツールを呼び出し、テスト実行やデプロイ、コード品質チェックなど高度なワークフローを組めます。

利用シーンの例

  • コードベースを渡して「関数名を一括変更してテストを更新して」と依頼する。
  • 「このサービスのIAMを最小権限にしたい」と相談して提案を受ける。
  • 新しいDockerfileやCI設定を生成してもらい、手元で動かす。

使い方は会話形式で直感的です。必要なファイルパスや目的を伝えるだけで、具体的な操作案や実行コマンドを受け取れます。

Amazon Q Developer CLIのインストールと初期セットアップ

対応OSと認証方法

Amazon Q Developer CLIはmacOSと各種Linuxディストリビューションで動作します。認証はAWS Builder IDまたは既存のAWSアカウントで行います。一般的にはAWS Builder IDでのログインが案内されますが、組織のAWSアカウントを使うことも可能です。

インストール手順(基本)

  1. AWS公式サイトから対応するプラットフォーム用のバイナリをダウンロードします。ダウンロードはブラウザまたはcurlで行えます。
  2. アーカイブを展開してバイナリを取り出します(例: tar や unzip を使用)。
  3. バイナリをPATHの通ったディレクトリに移動します(例: /usr/local/bin や ~/bin)。例: sudo mv q /usr/local/bin/
  4. 実行権限を付与します。例: sudo chmod +x /usr/local/bin/q
  5. インストール確認: q --version または which q でコマンドが見つかるか確認します。

初回セットアップ(認証フロー)

  1. ターミナルで q chat を実行します。
  2. 自動でブラウザが開き、ログイン画面が表示されます。画面の指示に従いAWS Builder IDでサインインしてください。
  3. 認証を許可すると、ブラウザ側で完了通知が出てCLIに戻り、継続してAmazon Q Developerの機能を利用できるようになります。

ヘッドレス/リモート環境での注意点

GUIのブラウザがない環境では、ブラウザが開けない場合にログイン用のURLやデバイスコードが表示されます。そのURLを別のブラウザで開いて認証してください。SSHでリモート接続している場合はローカルにブラウザをフォワードする方法も有効です。

よくあるトラブルと確認ポイント

  • PATHに正しく配置されているか (echo $PATH, which q) を確認してください。
  • 実行権限がない場合は chmod +x を実行してください。
  • ブラウザが開かないときは表示されたURLを手動で開いて認証してください。
  • プロキシやファイアウォールで外部接続が遮断されていると認証に失敗することがあります。ネットワーク設定を確認してください。

以上でインストールと初回セットアップは完了です。正常に認証できれば、以後CLIからAmazon Q Developerの各種コマンドを利用できます。

実践例①:コマンドラインだけでWebアプリを構築する

背景

Ricardo Sueiras氏の事例では、Amazon Q Developer CLIだけでシンプルなファクトチェックWebアプリを作成しました。準備は新規ディレクトリを作り、以下のファイルを置くだけです。

  • data-model/fact-checker.yaml(データ構造)
  • spec/SPEC.md(アプリ仕様)

実行手順(要点)

  1. 新規ディレクトリを作成します。
    bash
    mkdir fact-checker && cd fact-checker
  2. 上記ファイルを配置します。
  3. CLIで次のように指示します:
    bash
    q chat "Build a simple fact checking app"

    Qはファイル内容とプロンプトを読み取り、実装プランを立ててコード生成を開始します。報告ではコード生成に約12分かかりました。

生成後の自動化

Qは仮想環境の作成、依存パッケージのインストール、アプリの起動もCLI上で自動化しました。起動時にエラーが出ても、Qが自動で修正を試み、最終的にアプリが起動します。

UI調整の例

ボタンの整列が気になる場合、同じチャットで「Align buttons horizontally and improve spacing」と指示すると、Qが数分以内(事例では5分以内)に改善コードを再生成しました。これにより、プロトタイピングから動作確認、デザイン調整まで全てCLIで完結します。

実践のポイント

  • 仕様はSPEC.mdで具体的に書くと期待通りの生成が得られます。
  • 小さな修正はチャットで指示すれば素早く反映されます。
  • ローカルで動かせる簡単なチェックリストを用意するとトラブル対応が早くなります。

以上が、CLIだけでWebアプリを素早く作る実践例の流れです。

よかったらシェアしてね!
  • URLをコピーしました!

この記事を書いた人

目次