Mobiscroll CLI

The Mobiscroll Command Line Interface helps to install and configure the mobiscroll library into a project.

Installation

Using the node package manager (npm), the mobiscroll cli can be installed with the following command:

$ npm install -g @mobiscroll/cli

Config

Configures your current project with the Mobiscroll resources and dependencies. Use the --version option to define which supported main version would you like to install:

$ mobiscroll config [types] [options] --version=4

$ mobiscroll config [types] [options]

Options:

• -t, --trial The project will be tuned up with trial configuration.
• -i, --lite The project will be tuned up with lite configuration.
• -n, --no-npm Mobiscroll resources won't be installed from npm. In this case the Mobiscroll resources must be copied manually to the src/lib folder.
• -h, --help Output usage information
• --proxy [url] Define a proxy URL which will be passed to the internal requests.
• --scssThe project will be configured with scss styles instead of css.
• --cssThe project will be configured with css styles instead of scss.
• --version [version] Pass the Mobiscroll version which you want to install. It supports semver versions (--version="4.10.7") and main versions (--version="4"). In case of main version it will install the latest package available.

Types:

• angular Use it for configuring Angular 2+ applications.
• angularjs Use it for configuring Angularjs(1.x) applications.
• ionic Use it for configuring Ionic 2+ applications.
• javascript Use it for configuring JavaScript applications. Use it with frameworks like: Vue, Knockout, Ember.js...
• jquery Use it for configuring jQuery based applications.
• react Use it for configuring React applications.

Login

Logs you in to the Mobiscroll npm registry. (Use the --global flag if you want to login globally).

$ mobiscroll login [options]

Options:

• -h, --help output usage information

Logout

Logs you out from the Mobiscroll npm registry. (Use the --global flag if you want to log out globally).

$ mobiscroll logout [options]

Options:

• -h, --help output usage information

Start

Creates a new Mobiscroll starter project and installs the Mobiscroll resources from npm.

$ mobiscroll start [options] [types] [name]

Options:

• -t, --trial The project will be tuned up with trial configuration.
• -h, --help Output usage information
• --ionic-version Specify the ionic version of the ionic-angular starter.

Types:

• angular Creates an angular 6 applications.(Based on Angular CLI application.)
• ionic Creates an ionic application. (Based on Ionic 3 application.)
• ionic-angular Creates an ionic-angular application. (Based on Ionic 4/5 angular application.)
• ionic-react Creates an ionic-react application. (Based on Ionic 5 react application.)
• react Creates an react applications.(Based on Create React App application.)

Name - The name of the project you want to start

Using the CLI behind a proxy

If you're behind a proxy, the mobiscroll command might not work out of the box. There are multiple ways to solve this.

1. Using environment variables

The preferred way is to set the http_proxy and https_proxy environment variables on your system. This is usually needed for other CLI commands as well which are making requests and needs to be routed through a proxy server as well.

$ export http_proxy=http://myuser:mypassword@myproxy.com:1234
$ export https_proxy=http://myuser:mypassword@myproxy.com:1234

This will set the environment variables for the current terminal session. To permanently set the variables, add the above lines to your user's ~/.bash_profile or ~/.zshrc files.

$ setx HTTP_PROXY "http://myuser:mypassword@myproxy.com:1234"
$ setx HTTPS_PROXY "http://myuser:mypassword@myproxy.com:1234"

The setx command will permanently set the environment variables.

2. Using the --proxy parameter

The quick and dirty method without the need to modify any system configuration, is to pass the proxy address to the mobiscroll config command using the --proxy option. This will be used for any external request made to our servers or the npm registry.

$ mobiscroll config [framework] --proxy http://myuser:mypassword@myproxy.com:1234