Monaca CLI コマンド

コマンド 説明
monaca login Monaca へのサインインします。
monaca logout Monaca からサインアウトします。
monaca update CLI 2.x で作成したプロジェクトを最新の Monaca プロジェクト構成に更新します。
monaca init 他の CLI ツールを使用して作成したプロジェクトを初期化して、Monaca で実行できるようにします。
monaca signup Monaca のアカウント登録を行います。
monaca create テンプレートを使用して、ローカルに Monaca プロジェクトを新規作成します。
monaca clone Monaca クラウドからプロジェクトをクローンします。
monaca import Monaca クラウドからプロジェクトをインポートします。
monaca download Monaca クラウドからプロジェクトをダウンロードします。
monaca upload Monaca クラウドへプロジェクトをアップロードします。
monaca signing iOS と Android のビルド用の署名設定を管理します。
monaca remote build Monaca クラウド上で、プロジェクトをリモートビルドします。
monaca remote config Monaca クラウド上で、プロジェクト設定を開きます。
monaca preview ローカル上で Web サーバーを起動させます。
monaca debug Monaca デバッガー上でプロジェクトを実行します。
monaca transpile ソースコードをコード変換 ( トランスパイル ) します。
monaca config Monaca CLI の設定内容を管理できます。
monaca plugin Cordova プラグインを管理します。
monaca docs Monaca CLI、Onsen UI、チュートリアルを表示します。

monaca login

Monaca クラウドにサインインします。Monaca アカウント登録時のユーザー名とパスワードを入力します。

$ monaca login [options]

オプション

  • email: Monaca クラウドへログインするメールアドレス。

【具体例】

Monaca CLI を使用して、Monaca クラウドへログインします。

$ monaca login
$ monaca login me@monaca.io
$ echo "mypass" | monaca login me@monaca.io

monaca logout

Monaca クラウドからサインアウトして、保持していたログイントークンを削除します。

$ monaca logout

【具体例】

Monaca CLI を使用して、Monaca クラウドからログアウトします。

$ monaca logout
Signing out from Monaca Cloud...
You have been signed out.
Removed Monaca Debugger pairing information.

monaca update

このコマンドは、Monaca CLI 3.x から利用できます。 Monaca CLI 2.x で作成した旧プロジェクトを更新するために使用されます。

非トランスパイル プロジェクト

package.json には、以下の設定が追加されます。

  • monaca:preview コマンドが、script プロパティに追加されます。
  • dev コマンドが存在していない場合は、以下のコマンドが script プロパティに追加されます。
    • "dev": "browser-sync start -s www/ --watch --port 8080 --ui-port 8081"
  • browser-syncbordovaが、devDependencies として追加されます。

トランスパイル プロジェクト

package.json には、以下の設定が追加されます。

  • monaca:previewmonaca:transpilemonaca:debug コマンドが、script プロパティに追加されます。
  • devbuildwatch コマンドが存在していない場合は、script プロパティに追加されます。
  • webpackcordova を含む必須パッケージが、devDependenciesとして追加されます。
$ monaca update [options]

Options

  • --force: デフォルト設定で実行します。
  • --createPackageJson: プロジェクトに package.jsonファイルがない場合は、名前と説明を含む基本的な package.json ファイルを作成します。

Example

このコマンドの使用例です。

$ monaca update
$ monaca update --force --createPackageJson

monaca init

このコマンドは、Monaca CLI 3.x から利用できます。 Monaca( Monaca CLI、Monaca Cloud IDE、Monaca Localkit )で実行できるように、他の CLI ツールを使用して作成したプロジェクトを初期化します。 以下のリソースがプロジェクトに追加されます。

  • www/components: JS/CSS コンポーネント用フォルダーとリソースファイル。
  • config.xml: Cordova アプリ用グローバル設定ファイル。
  • res: Android、iOS、Window 用アイコンとスプラッシュ画像用フォルダーとリソースファイル。
  • cordova: Cordova 7.1 では、プロジェクトの package.json に cordova の設定がない場合は、devDependencies としてインストールされます。
  • .monaca/project_info.json: Cordova バージョンとフレームワークバージョンなどの情報を含む JSON ファイル。
$ monaca init

Example

このコマンドの使用例です。

$ monaca init

monaca signup

Monaca クラウド にサインアップします。 ユーザーの資格情報を要求する画面が表示されます。

$ monaca signup [options]

オプション

  • email: Monaca の登録に使用するメールアドレス

【具体例】

Monaca CLI を使用して、Monaca クラウドサインアップします。

$ monaca signup
$ monaca signup me@monaca.io

monaca create

指定したパスのテンプレートから新しいローカル Monaca プロジェクトを作成します。 Monaca クラウドが提供しているテンプレートの中から、使用するテンプレートを選択します。 指定された保存場所に、選択されたテンプレートが置かれます。

$ monaca create [options]

オプション

  • path: プロジェクトファイルの保存先
  • --url: Monaca テンプレート zip ファイルの URL

【具体例】

Monaca CLI を使用して、Monaca プロジェクトを作成します。

$ monaca create MyProject/Demo
$ monaca create MyProject/Demo --url http://github.com/me/myproject/archive/master.zip

monaca clone

Monaca クラウド上に置かれているプロジェクトを、ローカルへクローンします。Monaca クラウド上に置かれているプロジェクトの一覧が表示されます。プロジェクトを選択し、次に、保存先を指定します。

Monaca クラウドからローカル PC にプロジェクトをクローンする場合には、クローンしたプロジェクトに関する「 クラウド同期情報 」 が作成 ・ 保持されます。この情報が作成 ・ 保持されている場合、プロジェクトをローカルで修正した後、Monaca クラウドにアップロード ( monaca upload を使用 ) したときには、同一プロジェクト内の古いファイルが、上書きされます。
$ monaca clone

【具体例】

次の例では、Monaca クラウド上のプロジェクト「 Memo Application 」を、ローカルの「 CloneMemoProjectn 」フォルダーへクローンしています。

monaca import

Monaca クラウド上に置かれているプロジェクトをインポートします。Monaca クラウド上に置かれているプロジェクトの一覧が表示されます。プロジェクトを選択し、次に、保存先を指定します。

Monaca クラウドからローカル PC にプロジェクトをインポートする場合には、インポートしたプロジェクトに関する 「 クラウド同期情報 」 は作成されません。この情報が作成されない場合、プロジェクトをローカルで修正した後、Monaca クラウドにアップロード ( monaca upload を使用 ) したときには、アップロードしたプロジェクトは、新規のプロジェクトとして、取り扱われます。
$ monaca import

【具体例】

次の例では、Monaca クラウド上のプロジェクト「 Memo Application 」を、ローカルの「 ImportedMemoApplication 」フォルダーへインポートしています。

monaca download

Monaca クラウド上で同期対象のプロジェクトに対して行った更新・修正箇所をダウンロードします。

このコマンドを実行すると、ローカルのプロジェクトに、変更を反映できます。Monaca クラウド上に存在するプロジェクトと同一のプロジェクトが、ローカルに存在しない場合、このコマンドは使用できません。
$ monaca download [options]

オプション

  • --delete: Monaca クラウド上に存在しないローカルファイルを削除します。
  • --force: 処理の実行時、ユーザー側に確認しません。
  • --dry-run: ダウンロード処理をシュミレートします。出力として、ダウンロード対象のファイルを表示します。シュミレートのみで、実際のダウンロードは行われません。

【具体例】

プロジェクトフォルダーへ移動して、次に、さまざまなオプションを使用して monaca download コマンドを実行し、出力を確認してみましょう。

monaca upload

ローカルのプロジェクトを Monaca クラウドへアップロードします ( プロジェクトが置かれたディレクトリーのルートへ移動して、コマンドを実行します )。ローカルとクラウド間 ( 既存のファイルがクラウド上にあれば ) のファイルは比較され、新規ファイルまたは更新ファイルがあれば、そのファイルのみアップロードされます。アップロード処理は、プロジェクトの種類により、下記のように異なります。

  1. アップロード対象のプロジェクトが 「 新規プロジェクト」 または 「 インポートしたプロジェクト 」の場合、新規のプロジェクトとして、関連するファイルのすべてが Monaca クラウドへアップロードされます。
  2. アップロード対象のプロジェクトが 「 クローンしたプロジェクト 」場合、Monaca クラウド上に置かれている、クローン元のプロジェクトが上書きされます ( 新規ファイルまたは更新ファイルのみ、アップロードされます )。
トランスパイルが必要なプロジェクトに関しては、monaca upload コマンドの実行時、アップロード処理が始まる前に、プロジェクトがコード変換 ( トランスパイル / Transpile ) されます。
$ monaca upload [options]

オプション

  • --delete: ローカルに存在しないファイルが、Monaca クラウド上に存在する場合、クラウド上のこれらのファイルを削除します。
  • --force: 処理の実行時、ユーザー側に確認しません。
  • --dry-run: アップロード処理をシュミレートします。出力として、アップロード対象のファイルを表示します。シュミレートのみで、実際のアップロードは行われません。

【具体例】

プロジェクトフォルダーへ移動して、さまざまな オプション を組み合わせて、monaca upload コマンドを実行し、出力を確認してみましょう。

monaca signing

iOS および Android ビルド用の署名設定を管理します。

$ monaca signing <action> <item>

action

  • generate: keystorepkcsr で使うことができます。
  • upload: keystorepkcs12certificateprovisioning で使うことができます。
  • add: alias で使うことができます。
  • remove: aliaspkcs12certificateprovisioning で使うことができます。
  • export: keystorepkcsr で使うことができます。

item

  • alias: キーストアファイル内のエイリアス。
  • keystore: Android キーストア。
  • pkcsr: CSR ( 証明書署名要求 ) ファイル。
  • pkcs12: 証明書付きの秘密鍵。
  • certificate: iOS 証明書。
  • provisioning: iOS プロビジョニングプロファイル。
iOS および Android のビルド設定 ( キーストア、秘密鍵、証明書およびプロビジョニングプロファイルを含む ) の署名または作成方法の詳細については、 iOS のビルド設定 Android キーストア ( KeyStore ) の設定 を参照してください。

【具体例】

プロジェクトフォルダーへ移動して、次のようにコマンドを使用します。

$ 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 remote build

Monaca クラウド上でプロジェクトをビルドします。Monaca クラウド上に、対象のプロジェクトが存在しない場合、ビルドを開始する前に、対象のプロジェクトが自動的にアップロードされます。一方、Monaca クラウド上に、対象のプロジェクトがすでに存在する場合には、ローカルで行った更新・修正は、ビルドを開始する前に、対象のプロジェクトに反映 ( アップロード ) されます。

次の点に関する詳細は、ビルド をご確認ください。

  • 各プラットフォーム向けのビルドの設定方法
  • ビルドの種類
  • 各プラットフォーム向けアプリのビルド方法
  • ビルド済みアプリの入手方法・インストール方法
$ monaca remote build <platform> [options]

オプション

  • platform: ビルド対象のプラットフォームを指定します。iosandroidwindows のいずれかを指定します。
  • --build-type: ビルドの種類を指定します。指定できるオプションを、次に記します。

    • debug ( iOS、Android、Windows 向け) デフォルトオプション
    • test ( iOS 向け )
    • release ( iOS、Android 向け )
  • --output: ビルド済みファイルを保存するディレクトリーを指定します ( ファイル名まで含む )。

  • --android_webview: (Android のみ) Webview のタイプを選択します。defaultcrosswalk のいずれかを指定します。

  • --android_arch: (Android のみ) --android_webviewcrosswalk に指定した場合、こちらは必須オプションになります。値は、x86arm のいずれかを指定します。

  • --browser: ブラウザー上で [ ビルド設定 ] 画面を開きます ( 下のスクリーンショットを参照のこと )。

【具体例】

プロジェクトフォルダーへ移動して、さまざまなオプションを組み合わせてコマンドを実行してみましょう。

$ monaca remote build ios
$ monaca remote build ios --build-type=debug
$ monaca remote build android --build-type=debug --android_webview=crosswalk --android_arch=arm
$ monaca remote build --browser

monaca remote config

Monaca クラウド上でプロジェクト設定を開きます。
設定が完了したら、 monaca download を実行して変更した設定内容をローカルに反映してください。

$ monaca remote config

【具体例】

対象のプロジェクトフォルダに移動し、次のコマンドを実行してください:

$ monaca remote config
$ monaca download

monaca preview

ローカル上で Web サーバーを起動後、ブラウザー上でアプリを起動させます ( www 下のアセットがブラウザー上で使用できる状態になります )。このコマンドを実行すると、ファイルシステム上のファイルを監視し、ファイルが変更された場合には、ブラウザー上にも即反映させます。package.json で定義された npm run monaca:preview を実行します。

トランスパイルが必要なプロジェクトに関しては、monaca preview コマンドの実行時、プレビュー画面の起動前に、メモリー上でプロジェクトがコード変換されます。また、プレビュー画面を起動させた状態で、プロジェクトファイルを修正したときにも、コード変換処理が行われ、修正されたファイルの内容がプレビュー画面上に反映されます。
$ monaca preview

【具体例】

プロジェクトフォルダーへ移動して、monaca preview コマンドを実行します。実行後、ブラウザーが起動してプロジェクトが実行されます。

プレビュー用のウィンドウ

monaca preview の処理を停止する場合には、Ctrl+c を押します。

monaca debug

端末上でアプリをデバッグするためのコマンドです。ローカルで行った、ファイルへの変更は、デバッガー上にも即反映されます。このコマンドを実行すると、Web サーバーが起動され、Monaca デバッガーからの接続を待ち受けます。また、同時に、対象のローカルネットワーク上に接続されているデバッガーに対して、接続するか確認するメッセージが送信されます。package.json で定義された npm run monaca:debug を実行します。

トランスパイルが必要なプロジェクトに関しては、monaca debug コマンドの実行時、Monaca デバッガーへプロジェクトファイルが送信される前に、プロジェクトがコード変換 ( トランスパイル / Transpile ) されます。また、デバッガーを実行している状態で、プロジェクトファイルを修正したときにも、コード変換処理が行われ、修正されたファイルの内容がデバッガー上に反映されます。
$ monaca debug [options]

オプション

  • paths: ディレクトリー ( 現在開いているディレクトリーの場合には、省略可 )
  • --port: HTTP の待ち受けポート番号 ( デフォルトは、8001 )

【具体例】

プロジェクトフォルダーへ移動して、monaca debug コマンドを実行します。実行後、Monaca デバッガーの ローカルプロジェクト 下に対象のプロジェクトが表示されていることを確認し、プロジェクトをタップして実行してみましょう。次に、プロジェクトに変更を加え、保存して、プロジェクトに変更点が即反映されることを確認してみましょう。

$ cd MyProjectFolder/ImportRssProject
$ monaca debug

このコマンドの実行時、次のようなダイアログ ( 左 ) または通知 ( 右 ) が表示されます。ダイアログには、ペアリングを行うか確認するメッセージが表示されます。また、通知には、ネットワーク接続の状態が表示されます。なにか問題がある場合には、Monaca デバッガーとのペアリングが失敗する場合 をご確認ください。

接続確認用ダイアログ & ネットワーク接続完了の通知

monaca debug の処理を停止する場合には、Ctrl+c を押します。

monaca transpile

ReactJS、VueJS、Angular プロジェクトなど、トランスパイルが必要なプロジェクトをトランスパイルします。package.json で定義された npm run monaca:transpile を実行します。

$ monaca transpile

【具体例】

対象のプロジェクトフォルダーへ移動して、monaca transpile コマンドを実行します ( コード変換が可能なプロジェクトであること )。実行後、コード変換が実行されます。

$ monaca transpile

Running Transpiler...
Build completed in 71.835s

....

monaca config

プロキシおよび API エンドポイントの設定内容を管理できます。

$ monaca config [options]

オプション

  • proxy <url>: が設定されていない場合は、現在のプロキシサーバーが表示されます。
  • endpoint <url>: が設定されていない場合は、現在の API エンドポイントが表示されます。
  • --help: ヘルプを表示します。
  • --reset: デフォルト値にリセットします。

【具体例】

プロジェクトフォルダーへ移動して、次のようにコマンドを使用します。

$ 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 plugin

プロジェクトで使用するプラグインを管理します。プラグインの追加、削除、インストール済みのプラグイン一覧を行うことができます。

$ monaca plugin [options]

オプション

  • add <plugin>: プラグインを追加します。
  • rm <plugin>: プラグインを削除します。
  • ls または list: インストール済みのプラグインを一覧化します。
  • search <query>: プラグイン ディレクトリーを検索します。

【具体例】

プロジェクトフォルダーへ移動して、次のようにコマンドを使用します。

$ monaca plugin add org.apache.cordova.camera
$ monaca plugin rm org.apache.cordova.camera
$ monaca plugin search keyboard
$ monaca plugin ls

monaca docs

Monaca CLI 、Onsen UI 、チュートリアルのドキュメントを表示します。

$ monaca docs [options]

オプション

  • onsen: ブラウザで Onsen UI ドキュメントを開きます。
  • tutorial: ブラウザで Onsen UI チュートリアルを開きます。
  • usage: ブラウザで Monaca CLI ドキュメントを開きます。

【具体例】

プロジェクトフォルダーへ移動して、次のようにコマンドを使用します。

$ monaca docs onsen
$ monaca docs tutorial
$ monaca docs usage
Monaca ドキュメントチュートリアル