前回は、ローカル環境でMonacaプロジェクトを開発できるMonaca Localkitの利用方法について説明しました。Monacaでは、ローカル環境でMonacaプロジェクトの開発ができるMonaca CLIも提供しています。Monaca CLIは、Monaca Localkitと同様に有料プランで提供しているサービスになります。

Monaca CLIは、名前の通りコマンドライン形式のインターフェイスになるため、MonacaクラウドIDEやMonaca LocalkitのようなGUI形式のツールではありません。Monaca CLIを使用する場合は、コマンドプロンプト（Windowsの場合）やターミナル（macOSの場合）のようなツールを使用して処理を実行する必要があります。そのため、MonacaクラウドIDEやMonaca Localkitより使用するための難易度が高くなりますが、コマンドライン形式での開発に興味があれば、これから説明する内容を参考にチャレンジしてみてください。

今回は、Monaca CLIを使用するための基礎知識について説明していきたいと思います。今回の説明では、ターミナル（macOS）を使用しています。

事前準備

Monaca CLIは、npmパッケージとして提供されています。そのため、Monaca CLIを使用するためには、利用するPCに、Node.jsがインストールされている必要があります。

Node.jsを使用する際、多くの場合は、Node.jsのバージョン管理ツールを使用するケースが多いと思います。PCへのNode.jsのインストールについては、利用者の環境にあわせてインストールしてください。Node.jsのバージョンについては、MonacaのCordova 12環境で使用している18.16.0を使用して説明していきます。

Monaca CLIをインストールする

Monaca CLIを使用するためには、コマンドプロンプト（Windowsの場合）やターミナル（macOSの場合）のようなツールからコマンドを入力してインストールする必要があります。Monaca CLIをインストールするためのコマンドは、以下になります。

  • npm install -g monaca

通常、WindowsやmacOSにMonaca CLIをインストールする場合は、管理者用の権限が必要になります。上記のコマンドを実行した際にエラーが出力される場合は、以下のコマンドを実行してください。

  • sudo npm install -g monaca

インストールが完了したら、以下のコマンドを実行してみてください。バージョンが表示されていれば、正常にインストールが完了しています。

  • monaca -v

Monaca CLI コマンド

Monaca CLIでは、Monacaプロジェクトでの開発のためのコマンドが提供されています。Monaca CLIで提供されているコマンドについては、以下を参照してください。

今回の基礎知識編では、以下のコマンドについて説明していきたいと思います。

  • monaca signup
  • monaca login
  • monaca logout
  • monaca init
  • monaca config
  • monaca signing

monaca signup

Monaca CLIを使用してアプリ開発を行う場合は、Monaca CLIからMonacaクラウドへログインする必要があります。そのため、Monaca CLIを使用する場合は、事前にMonacaアカウントを作成する必要があります。Monaca CLIを使用する段階では、すでにMonacaアカウントを作成済みの場合が多いと思いますが、Monaca CLIからMonacaアカウントを作成する場合は、以下のコマンドを実行します。

  • monaca signup

monaca signupコマンドを実行すると、ブラウザーが起動し、アカウント作成画面が表示されます。

表示されたアカウント作成画面からMonacaアカウントを登録します。

monaca login

monaca loginコマンドを実行して、Monacaクラウドへログインします。monaca loginコマンドを実行すると、

  • Monacaアカウントに登録したメールアドレス
  • Monacaアカウントに設定したパスワード

を入力するコマンド待機画面になります。正しい情報を入力してMonacaクラウドへのログインが成功すると、以下のように表示されます。

monaca logout

monaca loginコマンドを実行すると、現在ログインしているMonacaアカウントが、Monacaクラウドからログアウトします。ログアウトが成功すると、以下のように表示されます。

monaca init

monaca initコマンドは、VueやReact等のCLIツールで作成されたプロジェクトをMonacaプロジェクトへ移行するためのコマンドになります。移行前のプロジェクトの構成によっては、Monacaプロジェクトとして利用できない場合がありますが、他のプラットフォームからMonacaへ移行する場合は、monaca initコマンドを実行します。他のプラットフォームからの移行については、下記も参照してください。

monaca config

monaca configコマンドは、利用しているネットワークでプロキシサーバを使用している場合やアプリが利用しているAPIでエンドポイント設定が必要な場合に使用します。注意点として、APIエンドポインを変更した場合、アプリケーションが正常に動作しなくなる場合があります。

monaca configコマンドの使用例は、以下になります。

monaca config --help
monaca config proxy
monaca config proxy http://my.proxy.com:8080
monaca config proxy --reset

monaca config endpoint
monaca config endpoint my.endpoint.com
monaca config endpoint --reset

monaca signing

monaca signingコマンドは、AndroidやiOSのビルドに必要な設定を行うコマンドになります。

monaca signingコマンドでは、以下のオプションが用意されています。monaca signingコマンドで作成されたファイルや追加、削除された情報については、MonacaクラウドIDEのAndroidキーストア設定画面、iOSビルド設定画面から確認できます。

  • monaca signing generate keystore
  • monaca signing generate pkcsr
  • monaca signing add alias
  • monaca signing upload keystore
  • monaca signing upload pkcs12
  • monaca signing upload certificate
  • monaca signing upload provisioning
  • monaca signing export keystore
  • monaca signing export pkcsr
  • monaca signing remove alias
  • monaca signing remove pkcs12
  • monaca signing remove certificate
  • monaca signing remove provisioning

monaca signing generate keystore

キーストアを作成してログインしているMonacaアカウントに登録するコマンドになります。作成されたキーストアは、MonacaクラウドIDEの Androidキーストア設定 画面から、以下のように確認できます。


monaca signing generate pkcsr

CSR（証明書署名要求）ファイルを作成してログインしているMonacaアカウントに登録するコマンドになります。作成されたCSRファイルは、Apple Developer Programから証明書を作成する際に使用できます。作成されたキCSRファイルは、MonacaクラウドIDEの iOSビルド設定 画面から、以下のように確認できます。


monaca signing add alias

Monacaアカウントに登録されているキーストアにエイリアスを追加するコマンドになります。追加されたエイリアスは、MonacaクラウドIDEの Androidキーストア設定 画面から、以下のように確認できます。


monaca signing upload keystore

既存のキーストアをMonacaアカウントに登録するコマンドになります。登録するには、キーストアのパスワードが必要になります。

monaca signing upload pkcs12

既存の証明書付き秘密鍵をMonacaアカウントに登録するコマンドになります。登録するには、ファイルに設定されているパスワードが必要になります。

monaca signing upload certificate

既存の証明書をMonacaアカウントに登録するコマンドになります。

monaca signing upload provisioning

既存のプロビジョニングプロファイルをMonacaアカウントに登録するコマンドになります。

monaca signing export keystore

Monacaアカウントに登録されているキーストアをエクスポートするコマンドになります。キーストアは、Google Play Consoleに登録されているアプリをアップデートする際に必要なファイルになります。現在登録されているキーストアを使用してGoogle Play Consoleに登録されているアプリをアップデートしている場合は、キーストアをエクスポートしてローカルPC上に保存することをお勧めします。

monaca signing export pkcsr

Monacaアカウントに登録されているCSR（証明書署名要求）ファイルをエクスポートするコマンドになります。CSRで作成した署名書の有効期限が切れた場合でも、同じCSRを使用して、再度証明書を作成する事ができます。CSRをエクスポートしてローカルPC上に保存することで、新規にCSRを作成する必要がなくなります。

monaca signing remove alias

Monacaアカウントに登録されているキーストアのエイリアスを削除するコマンドになります。処理が成功した場合は、以下のように表示されます。

monaca signing remove pkcs12

Monacaアカウントに登録されている証明書付き秘密鍵を削除するコマンドになります。処理が成功した場合は、以下のように表示されます。

monaca signing remove certificate

Monacaアカウントに登録されている証明書を削除するコマンドになります。処理が成功した場合は、以下のように表示されます。

monaca signing remove provisioning

Monacaアカウントに登録されているプロビジョニングプロファイルを削除するコマンドになります。処理が成功した場合は、以下のように表示されます。

おわりに

今回は、Monaca CLIを利用するための基礎知識について説明しました。Monaca CLIは、コマンドラインで処理を行うため、MonacaクラウドIDEやMonaca LocalkitのようなGUIと比べると、利用するための難易度が高くなりますが、コマンドラインでの処理に慣れてくると、GUIよりも作業効率が高くなる場合があります。これまでコマンドラインでの開発を行ったことがない場合は、この機会に、Monaca CLIを試してみてください。次回は、Monaca CLIでの開発について説明したいと思います。