docs

TOP(About this memo)) > 一覧(Flutter) > CLI

ドキュメント

• https://docs.flutter.dev/reference/flutter-cli
• https://dart.dev/tools/pub/cmd
• Flutterのコマンドは内部的に Dartのコマンドを利用している。

グローバルオプション

• –help(-h)
• -v, –verbose
  • 内部で実行されているシェルコマンドのログを詳細に出力する
• -d, –device-id
  • 実行環境を指定
• –version

ヘルプ

• flutter --help

プロジェクト作成

• flutter create
  • flutter create --org com.example your_project_name
  • サンプルプロジェクトから作成
    • flutter create --sample=widgets.PageStorage.1 mysample
    • APIのドキュメントにサンプルの名前が記載されているものもある。
  • 現在のディレクトリ内で生成
    • flutter create --org com.example .
    • プロジェクト名はディレクトリ名となる。
  • テンプレート
    • flutter create --template=app
      • –templateを指定しない場合もデフォルトでappとなる。
    • module, package, plugin, plugin_ffi, skeleton

flutterのインストール状態の確認

• flutter doctor
• 各種ツールチェインが正常にインストールされていることを確認

pub系コマンド

• flutter pub get
  • pubspec.ymlに基づいてパッケージをダウンロード・更新
  • pub getコマンドはアプリが依存するパッケージを判断し、それをキャッシュフォルダへ配置する。
  • SDKの場合はこのキャッシュフォルダはインストール先のフォルダ内（/flutter 等）、外部パッケージの場合は/.pub-cacheに入っている
  • 参考
    • https://www.cresc.co.jp/tech/java/Google_Dart2/development/pub/pub.html
• flutter pub add
  • このコマンドはdart pub addと同じ処理をしている。
  • なお、dart pub add 〜　は pubspec.yamlにパッケージを追加して　dart pub getを実行することと等価である。
• flutter pub remove
  • flutter pub remove パッケージ名
• flutter pub run
  • 各パッケージで実装されたコマンドを実行する。
  • 例
    • flutter pub run flutter_native_splash:create

デバイス確認

• flutter devices --machine
  • 現在動作できるシミュレーターや端末を確認

実行

• flutter run -d デバイス
• pub get、ビルド、インストール、実行まで全てを行う。ホットリロードなどのショートカットも表示される
• モードの指定
  • https://docs.flutter.dev/testing/build-modes
  • –debug(デフォルト)
    • JITコンパイルでHOTリロードが利用可能
    • アサーションが有効となっている。
    • なお、端末上でアプリアイコンをタップすることで再度開くことはできない。
      • profileモード以上が必要。
  • –profile
    • リリースに近いパフォーマンスとなる。
    • パフォーマンスの分析が可能。
  • –release
    • ホットリロード等のデバッグ機能は利用できない。(AOTコンパイルとなる)
    • iOSシミュレータが利用できない
    • リリース時のパフォーマンスを確認できる。
• –[no-]build
  • ビルドを行うか否かを指定。
  • デフォルトは–build
  • ビルドの対象は、対象のデバイスで実行可能な対象をビルドすると考えられる。
• –[no-]hot
  • ホットリロード機能をONで利用するか否かを指定。
  • デフォルトは–hot
• –target
  • エントリーポイント
  • デフォルトではlib/main.dart
• –dart-define-from-file
  • dart-defineのファイルを指定できる。
• 表示されるURLをブラウザから開くとインスペクタにて確認が可能。
  • (参考)(IME) このURLは、例えば「 http://127.0.0.1:9102?uri=http://127.0.0.1:65045/AH4QroZkvO8=/」のようになっているが、
    • 「http://127.0.0.1:9102」は、flutter runが「dart devtools」によって起動したdevtool
    • 「http://127.0.0.1:65045/AH4QroZkvO8=/」は、起動したDart VMが提供するURL
    • 参考
      • https://zenn.dev/tatsuyasusukida/scraps/a740047660e72e

ビルド、インストール

• flutter build [target]
  • デフォルトがリリースモードとなる。
    • (IMO)
      • 基本的にflutter runでデバッグをするため、flutter buildを利用する際にリリースモード以外を利用することはないだろう。
  • flutter build ios
    • iosアプリをビルドする
  • flutter build apk
    • androidアプリをビルドする
  • flutter build ipa
    • iosのアーカイブ(ipa)ファイルを生成する
• flutter install

クリーン

• flutter clean
• build/と.dart_tool/ ディレクトリを削除

デバイスのデタッチ・アタッチ

• https://docs.flutter.dev/add-to-app/debugging
• デタッチ
  • flutter runを実行した後に d を押下するとデタッチされる。
• flutter attach --device-id (対象のデバイス)
  • 再度デバイスをアタッチ
  • –device-id でデバイスを指定しない場合、先頭のデバイスが使われる？

フォーマット

• dart format
• ※ flutter format は dart formatをラップするコマンドだったが削除された。
  • https://github.com/flutter/flutter/pull/129360

(参考) Github Actionsにdart formatを追加する

• https://starhoshi.hatenablog.com/entry/2023/05/19/172447

その他

• flutter screenshot --out 出力先ファイル
  • 現在接続中のデバイスのスクリーンショットを撮る
• パッケージの依存関係のツリーを表示
  • flutter pub deps

This site is open source. Improve this page.