【Flutter】初学者向けのCLIコマンド
CLI のコマンドの種類がどれぐらいあるか知らなかったので、ドキュメントに記載されている個人的に使えそうなコマンドをメモしていきます。
Flutter CLI コマンド
Flutter CLI には多くのコマンドがありますが、主に以下のカテゴリに分けられます：
Flutter SDK 管理コマンド
channel
チャンネルの一覧表示や切り替えを行います。
チャンネルとは？
3 つのチャンネルが存在します。
安定版(Stable)チャンネル：
最も安定した Flutter ビルドを含むチャンネルです。おおよそ 3 回ごとのベータバージョンが安定版として昇格します。新規ユーザーやプロダクション用アプリのリリースには、この安定版チャンネルが推奨されています。
ベータ(Beta)チャンネル：
利用可能な最新バージョンの Flutter ですが、まだ安定版ではありません。ベータ版は通常、毎月第一水曜日にリリースされます。修正プログラムは通常、メインチャンネルに導入されてから約 2 週間後にベータチャンネルに反映されます。リリースはインストールバンドルとして配布されます。
メイン(Main)チャンネル：
最新機能を含みますが、完全にテストされておらず、バグがある可能性があります。Flutter 自体に貢献する場合を除き、使用は推奨されていません。
// 現在のチャンネルと利用可能なチャンネルを表示
flutter channel
// stableチャンネルに切り替え
flutter channel stable
upgrade
Flutter を最新バージョンにアップグレードします。
// Flutter SDKを最新バージョンにアップグレード
flutter upgrade
downgrade
現在のチャンネルの最後のアクティブバージョンにダウングレードします。
// 以前のバージョンにダウングレード
flutter downgrade
config
Flutter 設定を構成します。
// 設定を表示
flutter config
利用するオプション例
--android-sdk: Android の開発環境へのパスを設定
--android-studio-dir: Android Studio のインストールディレクトリを設定
--enable-web: Web アプリ開発を有効化
--enable-linux-desktop: Linux 向けデスクトップアプリ開発を有効化
--enable-macos-desktop: macOS 向けデスクトップアプリ開発を有効化
--enable-windows-desktop: Windows 向けデスクトップアプリ開発を有効化
--no-analytics: 分析データの収集を無効化
doctor
インストールされたツールの情報を表示し、Flutter 開発環境の問題を診断します。
// 基本的な診断情報を表示
flutter doctor
// 詳細な診断情報を表示
flutter doctor -v
プロジェクト管理コマンド
create
指定したディレクトリに新しい Flutter プロジェクトを作成します。
// 基本的なFlutterアプリプロジェクトを作成
flutter create my_app
// 組織名を指定してプロジェクトを作成
flutter create --org com.example my_app
analyze
プロジェクトの Dart コードを静的解析して問題を検出します。
この辺りは VScode の設定で自動で解析する設定にしています。
// プロジェクトのコードを解析
flutter analyze
// コード変更を監視し、変更時に自動的に解析を実行
flutter analyze --watch
test
現在のプロジェクトの Flutter ユニットテストを実行します。
// すべてのテストを実行
flutter test
// 特定のテストファイルを実行
flutter test test/widget_test.dart
run
接続されたデバイスで Flutter アプリを実行します。
// デバッグモードでアプリを実行
flutter run
// リリースモードでアプリを実行
flutter run --release
// 特定のデバイスでアプリを実行
flutter run -d emulator-5554
build
実行可能なアプリケーションまたはインストールバンドルをビルドします。
// Android APKをビルド
flutter build apk
// iOS用にビルド
flutter build ios
// Webアプリケーションとしてビルド
flutter build web
clean
build/と.dart_tool/ディレクトリを削除して、プロジェクトをクリーンな状態にします。
// ビルド済みファイルやキャッシュを削除
flutter clean
pub
Flutter パッケージを管理するコマンドです。
// 依存パッケージのインストール
flutter pub get
// 古くなったパッケージの確認
flutter pub outdated
// パッケージのアップグレード
flutter pub upgrade
drive
接続されたデバイスやエミュレータでプロジェクトの統合テストを実行します。
// 統合テストの実行
flutter drive --target=test_driver/app.dart
深堀りしたい。
gen-l10n
現在のプロジェクトのローカリゼーションファイルを生成します。
// 多言語対応のためのファイル生成
flutter gen-l10n
ツール＆デバイスコマンド
devices
接続されているすべてのデバイスを一覧表示します。
// 利用可能なデバイスを表示
flutter devices
emulators
エミュレータの一覧表示、起動、作成を行います。
// 利用可能なエミュレータを一覧表示
flutter emulators
// 特定のエミュレータを起動
flutter emulators --launch pixel_4
install
接続されたデバイスに Flutter アプリをインストールします。
// ビルド済みアプリをデバイスにインストール
flutter install
screenshot
接続されたデバイスからスクリーンショットを撮ります。
// スクリーンショットを撮り、ファイルに保存
flutter screenshot --out=screenshot.png
Discussion