Skip to main content
Version: 5.35.0

Mobiscroll CLI

Overview​

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

info

Requires Node.js 11 or newer.

Installation​

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

$ npm install -g @mobiscroll/cli
info

On Windows client computers, the execution of PowerShell scripts is disabled by default. When using Powershell, to be able to install the Mobiscroll CLI you will need to set the following execution policy:

Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy RemoteSigned

Make sure to read the message displayed after executing the command and follow the instructions.

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:

Install the latest version
$ mobiscroll config [types] [options]
Install the latest v4 version
$ mobiscroll config [types] [options] --version=4

Options:

  • -t, --trial: The project will be configured with the trial version.
  • -n, --no-npm: This option can be used if you are building a custom package with the download builder. Mobiscroll resources won't be installed from npm. In this case the Mobiscroll resources must be copied manually to the src/lib folder from the downloaded package.
  • -h, --help: Output usage information.
  • --proxy [url]: Define a proxy URL which will be passed to the internal requests.
  • --scss: The project will be configured with scss styles instead of css.
  • --css: The project will be configured with css styles instead of scss.
  • --legacy-peer-deps: This option will be passed to internally executed npm install command.
  • --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 4+ applications.
  • ionic: Use it for configuring Ionic 2.2.0+ applications.
  • javascript: Use it for configuring JavaScript applications. Use it with frameworks like: Knockout, Ember.js...
  • jquery: Use it for configuring jQuery 1.7+ applications.
  • react: Use it for configuring React 16.2+ applications.
  • vue: Use it for configuring Vue 3+ 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.

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.

Mac OS / Linux
$ 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.

Windows
$ 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.

  1. 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