Overview

Introduction

Monaca CLI is one of the local deveopment environments which can be used to develop Monaca apps locally. Monaca CLI provides command line interface for using Monaca Cloud from your local PC. With Monaca CLI, you can:

  • Create new local projects, import or clone existing projects in Monaca Cloud into your host PC.
  • Develope Monaca apps with any local code editors you prefer.
  • Debug your app with inspector integration.
  • Support transpiler options for transpilable projects such as ReactJS and Angular2 projects.
  • Remote build your projects without any setups locally.

Getting Started

Prerequisite

You are required to have Node.js installed on your PC in order to install Monaca CLI.

Step 1: CLI Installation

Use the following command to install Monaca CLI:

$ npm install -g monaca

On some systems you may have to prefix the command with sudo because of permission issue:

$ sudo npm install -g monaca
In order to check the currently installed Monaca CLI’s version, use monaca command. Moreover, if you want to update Monaca CLI, just re-install it using the above command.

Step 2: Following CLI Tutorial

After successfully installed Monaca CLI, please follow our simple and easy tutorial on how to use Monaca CLI.

Transpiling in Monaca CLI

Some of the modern frameworks have created their own languages in order to interact with their products (like JSX), or have just integrated some extensions that are not natively available in JavaScript (for example TypeScript). The transpiling process transforms the code written with those languages to a native JavaScript code ready to be executed on modern browsers/WebViews. We currently use WebPack to perform the transpiling operations.

Currently, it is available for the Vue, React and Angular2 templates. It can be triggered in two ways:

  1. monaca transpile: runs the transpiler on the current project. If the --watch argument is given, the transpiler will automatically run every time the source code is updated (and saved).
  2. monaca preview: runs the transpiler in watch mode and starts an HTTP Server in order to display the app’s content.

Upload/Download Control

There are cases where you want ignore/exclude specific files and folders from uploading to Monaca Cloud. In this case, the .monacaignore file will be automatically created and placed under the root directory of the React Native projects. You can edit the file to add or remove specific files and folders.

.monacaignore is using the same pattern as .gitignore.

Here is the default settings within the .monacaignore file:

node_modules
.git
.monaca/*
!.monaca/project_info.json
android/build
ios/build
build
.DS_Store

See Also: