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:
Types:
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:
Types:
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