AWS Amplify CLI チートシート

Amplify CLI チートシート

設定

用途	コマンド	備考
CLIで利用するAWS IAMユーザの設定	amplify configure	プロファイルの設定等が可能
amplify プロジェクトの作成、初期化	amplify init

確認

用途	コマンド	備考
Amplify API/Hosting/Auth等のリソースの 作成状況（展開ステータス）の確認	amplify status
ブラウザでAWS Amplify コンソールを開く	amplify console
環境の一覧表示	amplify env list	"*"付表示が現在の環境
プラグインの確認	amplify plugin list

作成リソースのpush, pull等

用途	コマンド	備考
ローカルのバックエンドリソースを クラウド上にプロビジョニング	amplify push
ローカル バックエンドおよびフロントエンド リソース (ホスティング カテゴリが追加されている場合) を構築し、クラウドでプロビジョニング	amplify publish	ローカルでホスティングリソース、コンテンツを作成した後、クラウド上にホスティングさせる際に使用
クラウド上のAmplify リソースをローカルに反映	amplify pull	--envName <環境名>で環境指定。強制上書きの為注意。 差分を残したい場合はamplify env pullコマンドを使用

環境操作

用途	コマンド	備考
環境の追加	amplify env add
環境の切り替え	amplify env checkout <環境名>
環境の詳細情報表示	amplify env get	--name <環境名>で環境指定
ローカルにある既存のAmplify プロジェクトの環境をインポート	amplify env import	--name <環境名>で環境指定
環境指定して、クラウド上からリソースを取得	amplify env pull	--name <環境名>で環境指定 --restoreで既存環境の上書き
環境の削除	amplify env remove <環境名>
環境設定のアップデート	amplify env update

リソースの操作

用途	コマンド	備考
リソースの追加	amplify add <category>	category: API/Function/Hosting/Auth
個々のリソースの削除	amplify remove <category>
Amplify プロジェクト全体の削除	amplify delete
APIリソースの操作	amplify api	サブコマンド：add push stasus remove gql-compileなど
ストレージリソースの操作	amplify strage
認証リソース操作	amplify auth	サブコマンド：add push removeなど
ホスティングリソースの操作	amplify hosting	サブコマンド：serve configure remove publish など
関数リソースの操作	amplify function	サブコマンド：add push build removeなど

ホスティングリソースの操作

用途	コマンド	備考
デプロイされたサイトを開く	amplify hosting serve
デプロイされたアプリの変更を公開	amplify hosting publish
コンソールを開き、リソースの設定を行う	amplify hosting configure
アプリからホスティングを削除	amplify hosting remove
ローカルのホスティングリソースの変更をクラウド上にプロビジョニング	amplify hosting push

テスト

用途	コマンド	備考
モックサーバのローカル実行	amplify mock	サブコマンド：api storage function function <function name>

Appendix

プラグイン

用途	コマンド	備考
Amplify CLIプラグインを初期化	amplify plugin init
Amplify CLIプラグインを追加	amplify plugin add
Amplify CLIプラグインを削除	amplify plugin remove

参照

Amplify CLI 公式ドキュメント