node package manager
Painless code sharing. npm Orgs help your team discover, share, and reuse code. Create a free org »

indui

indui-cli

The indui Framework command line utility makes it easy to start, build, run, and emulate indui apps. In addition, it comes with (optional!) integration with the indui Platform, a set of mobile services perfect for indui apps.

Use the indui --help command for more detailed task information.

Installing

$ npm install -g indui

*Note: For a global install of -g indui, OSX/Linux users may need to prefix the command with sudo or can setup proper file permissions on OSX for npm to install without sudo. *

Starting an indui App

$ indui start myapp [template]

Starter templates can either come from a named template, a Github repo, a Codepen, or a local directory. A starter template is what becomes the www directory within the Cordova project.

Named template starters:

Github Repo starters:

Codepen URL starters:

Plunker URL starters:

Local directory starters:

  • Relative or absolute path to a local directory

Command-line flags/options:

[--appname|-a]  .......  Human readable name for the app
                         (Use quotes around the name)
[--id|-i]  ............  Package name set in the <widget id> config
                         ex: com.mycompany.myapp
[--no-cordova|-w]  ....  Do not create an app targeted for Cordova
[--sass|-s] ...........  Setup the project to use Sass CSS precompiling
[--list|-l]  ..........  List starter templates available

[--io-app-id] .........  The indui.io app ID to use

Adding a platform target

$ indui platform ios android

Testing in a Browser

Use indui serve to start a local development server for app dev and testing. This is useful for both desktop browser testing, and to test within a device browser which is connected to the same network. Additionally, this command starts LiveReload which is used to monitor changes in the file system. As soon as you save a file the browser is refreshed automatically. View Using Sass if you would also like to have indui serve watch the project's Sass files.

$ indui serve [options]

Building your app

$ indui build ios

Live Reload App During Development (beta)

The run or emulate command will deploy the app to the specified platform devices/emulators. You can also run live reload on the specified platform device by adding the --livereload option. The live reload functionality is similar to indui serve, but instead of developing and debugging an app using a standard browser, the compiled hybrid app itself is watching for any changes to its files and reloading the app when needed. This reduces the requirement to constantly rebuild the app for small changes. However, any changes to plugins will still require a full rebuild. For live reload to work, the dev machine and device must be on the same local network, and the device must support web sockets.

With live reload enabled, an app's console logs can also be printed to the terminal/command prompt by including the --consolelogs or -c option. Additionally, the development server's request logs can be printed out using --serverlogs or -s options.

Command-line flags/options for run and emulate:

[--livereload|-l] .......  Live Reload app dev files from the device (beta)
[--consolelogs|-c] ......  Print app console logs to indui CLI (live reload req.)
[--serverlogs|-s] .......  Print dev server logs to indui CLI (live reload req.)
[--port|-p] .............  Dev server HTTP port (8100 default, live reload req.)
[--livereload-port|-i] ..  Live Reload port (35729 default, live reload req.)
[--all|-a] ..............  Specify to run on all addresses, 0.0.0.0, so you can view externally
[--browser|-w] ..........  Specifies the browser to use (safari, firefox, chrome)
[--browseroption|-o] ....  Specifies a path to open to (/#/tab/dash)
[--debug|--release]

While the server is running for live reload, you can use the following commands within the CLI:

restart or r to restart the client app from the root
goto or g and a url to have the app navigate to the given url
consolelogs or c to enable/disable console log output
serverlogs or s to enable/disable server log output
quit or q to shutdown the server and exit

Emulating your app

Deploys the indui app on specified platform emulator. This is simply an alias for run --emulator.

$ indui emulate ios [options]

Running your app

Deploys the indui app on specified platform devices. If a device is not found it'll then deploy to an emulator/simulator.

$ indui run ios [options]

Icon and Splash Screen Image Generation

Automatically generate icons and splash screens from source images to create each size needed for each platform, in addition to copying each resized and cropped image into each platform's resources directory. Source images can either be a png, psd Photoshop or ai Illustrator file. Images are generated using indui's image resizing and cropping server, instead of requiring special libraries and plugins to be installed locally.

Since each platform has different image requirements, it's best to make a source image for the largest size needed, and let the CLI do all the resizing, cropping and copying for you. Newly generated images will be placed in the resources directory at the root of the Cordova project. Additionally, the CLI will update and add the correct <platform> configs to the project's config.xml file.

During the build process, Cordova (v3.6 or later) will look through the project's config.xml file and copy the newly created resource images to the platform's specific resource folder. For example, Android's resource folder can be found in platforms/android/res, and iOS uses platforms/ios/APP_NAME/Resources.

Icon Source Image

Save an icon.png, icon.psd or icon.ai file within the resources directory at the root of the Cordova project. The icon image's minimum dimensions should be 192x192 px, and should have no rounded corners. Note that each platform will apply it's own mask and effects to the icons. For example, iOS will automatically apply it's custom rounded corners, so the source file should not already come with rounded corners. This Photoshop icon template provides the recommended size and guidelines of the artwork's safe zone.

$ indui resources --icon

Splash Screen Source Image

Save a splash.png, splash.psd or splash.ai file within the resources directory at the root of the Cordova project. Splash screen dimensions vary for each platform, device and orientation, so a square source image is required the generate each of various sizes. The source image's minimum dimensions should be 2208x2208 px, and its artwork should be centered within the square, knowning that each generated image will be center cropped into landscape and portait images. The splash screen's artwork should roughly fit within a center square (1200x1200 px). This Photoshop splash screen template provides the recommended size and guidelines of the artwork's safe zone. Additionally, when the Orientation preference config is set to either landscape or portrait mode, then only the necessary images will be generated.

$ indui resources --splash

Generating Icons and Splash Screens

To generate both icons and splash screens, follow the instructions above and run:

$ indui resources

Platform Specific Resource Images

One source image can be used to generate images for each platform by placing the file within the resources directory, such as resources/icon.png. To use different source images for individual platforms, place the source image in the respective platform's directory. For example, to use a different icon for Android, it should follow this path: resources/android/icon.png, and a different image for iOS would use this path: resources/ios/icon.png.

Generating Exact Platform Resources

By default the indui resources command will automatically figure out which platforms it should generate according to what platforms have been added to your project. However, you can also explicitly state which resources should be built by providing a platform name in the command. The example below would generate only ios resources (even if the platform hasn't been added to the project).

$ indui resources ios

Default indui Resources

indui provides you some default icons and splash screens to give you a better idea of how to size your icons and splashscreen, as well as how to modify your config.xml file for your own icons.

$ indui resources --default

If you already have a resources directory, the command above will not over write your files. If you wish to force an over write, use indui resources --default --force.

When starting a new app and adding a platform indui platform add ios - the default icons and splashscreens will be downloaded and your config.xml will be modified to set up the default resources. This should help you identify your indui apps easier as well as help you get the file structure and configuration correct.

Crosswalk for Android

In v1.3.0 and later, you can now specify which browser to use in your Cordova Android projects. Currently we only support Crosswalk and have plans to support more browsers later.

Execute indui browser add crosswalk to add the Crosswalk browser to your Android project. By default, this will install the 12.41.296.5 version of Crosswalk.

If you'd like to specify a different version of Crosswalk, run indui browser list to see which browsers are available and what versions. Then run indui browser add crosswalk@10.39.235.15.

All that is left is to run the project as normal - indui run android.

If you'd like to build without Crosswalk for Android SDK 21 or later, do the following:

indui browser revert android
indui build android --release -- --minSdkVersion 21

Advanced serve options

LiveReload

By default, LiveReload will watch for changes in your www/ directory, excluding www/lib/. To change this, you can specify a watchPatterns property in the indui.project file located in your project root to watch (or not watch) for specific changes.

{
  "name": "myApp",
  "app_id": "",
  "watchPatterns": [
    "www/js/*",
    "!www/css/**/*"
  ]
}

For a reference on glob pattern syntax, check out globbing patterns on the Grunt website.

Gulp Integration

When running indui serve, you can have indui run any Gulp tasks you specify by putting them into your indui.project as a gulpStartupTasks property as follows:

{
  "name": "SmoothRiders",
   "gulpStartupTasks": [
    "watch"
  ]
}
 

Now, when you run indui serve, it will run the watch task while starting the indui server.

If you would like to disable gulp from running during serve, pass the --nogulp option.

NOTE:

$ indui setup sass

will add a watchPatterns propery with the default values to your indui.project file that you can then edit, in addition to the gulpStartupTasks property described in the Using Sass section.

Service Proxies:

The serve command can add some proxies to the http server. These proxies are useful if you are developing in the browser and you need to make calls to an external API. With this feature you can proxy request to the external api through the indui http server preventing the No 'Access-Control-Allow-Origin' header is present on the requested resource error.

In the indui.project file you can add a property with an array of proxies you want to add. The proxies are object with the following properties:

  • path: string that will be matched against the beginning of the incoming request URL.
  • proxyUrl: a string with the url of where the proxied request should go.
  • proxyNoAgent: (optional) true/false, if true opts out of connection pooling, see HttpAgent
{
  "name": "appname",
  "email": "",
  "app_id": "",
  "proxies": [
    {
      "path": "/v1",
      "proxyUrl": "https://api.instagram.com/v1"
    }
  ]
}
 

Using the above configuration, you can now make requests to your local server at http://localhost:8100/v1 to have it proxy out requests to https://api.instagram.com/v1

For example:

angular.module('starter.controllers', [])
.constant('InstagramApiUrl', '')
// .contant('InstagramApiUrl','https://api.instagram.com') 
//In production, make this the real URL 
 
.controller('FeedCtrl', function($scope, $http, InstagramApiUrl) {
 
  $scope.feed = null;
 
  $http.get(InstagramApiUrl + '/v1/media/search?client_id=1&lat=48&lng=2.294351').then(function(data) {
    console.log('data ' , data)
    $scope.feed = data;
  })
 
})

See also this gist for more help.

Command-line flags/options:

[--consolelogs|-c] ......  Print app console logs to indui CLI
[--serverlogs|-s] .......  Print dev server logs to indui CLI
[--port|-p] .............  Dev server HTTP port (8100 default)
[--livereload-port|-i] ..  Live Reload port (35729 default)
[--nobrowser|-b] ........  Disable launching a browser
[--nolivereload|-r] .....  Do not start live reload
[--noproxy|-x] ..........  Do not add proxies
[--address] .............  Serves in the browser at the specified address
[--lab] .................  Serves both iOS and Android in the browser
[--nogulp] ..............  Serve without running gulp tasks
[--platform|-t] .........  Serve the platform specific styles in the browser (ios/android)

Using indui Labs

We've extended the serve command to open the new Lab UI that features iOS and Android side-by-side.

$ indui serve --lab

If you've used the serve command before, you'll feel right at home with this one. Just like serve, it opens your app in a browser, but now it shows you what your app will look like on a phone, with both iOS and Android side by side.

And of course, it supports Live Reload and all the other goodies we've added over the last couple of months.

Serving an alternate document root

If you'd like to test your app in the browser and you use a folder other than the default of www, you can specify this folder in your indui.project file.

You might also want to have the document root be created if you use some sort of build system, we suggest using createDocumentRoot for that so that indui serve will create that folder for you.

It is also advised you specify the watch patterns for this document root as well, as follows:

{
  "name": "SmoothRiders",
   "gulpStartupTasks": [
    "watch"
  ],
  "documentRoot": "app",
  "createDocumentRoot": "app",
  "watchPatterns": [
    "app/js/*",
    "!app/css/**/*"
  ]
}
 

Update indui lib

Update indui library files, which are found in the www/lib/indui directory. If bower is being used by the project, this command will automatically run bower update indui, otherwise this command updates the local static files from indui's CDN.

$ indui lib update

Note: Using bower? This command does not update indui's dependencies. Run bower update to update indui and all of it's dependencies defined in bower.json.

Packaging an app (beta)

Using indui's service, you can compile and package your project into an app-store ready app without requiring native SDKs on your machine.

$ indui package debug android

The third argument can be either debug or release, and the last argument can be either android or ios.

Cordova Commands

indui uses Cordova underneath, so you can also substitute Cordova commands to prepare/build/emulate/run, or to add additional plugins.

Note: we occasionally send anonymous usage statistics to the indui team to make the tool better.

Working around proxies

If you have a proxy you need to get around, you can pass that proxy with the default http_proxy node environment variable or an environment variable proxy.

A few ways to set up and use the environment variable:

export http_proxy=internal.proxy.com
# Or
export PROXY=internal.proxy.com
 
indui start my_app
 
# Additionally, pass in line
PROXY=internal.proxy.com indui start my_app

Using Sass

By default, starter projects are hooked up to indui's precompiled CSS file, which is found in the project's www/lib/indui/css directory, and is linked to the app in the head of the root index.html file. However, indui projects can also be customized using Sass, which gives developers and designers "superpowers" in terms of creating and maintaining CSS. Below are two ways to setup Sass for your indui project (the indui setup sass command simply does the manual steps for you). Once Sass has been setup for your indui project, then the indui serve command will also watch for Sass changes.

Setup Sass Automatically

indui setup sass

Setup Sass Manually

  1. Run npm install from the working directory of an indui project. This will install gulp.js and a few handy tasks, such as gulp-sass and gulp-minify-css.
  2. Remove <link href="lib/indui/css/indui.css" rel="stylesheet"> from the <head> of the root index.html file.
  3. Remove <link href="css/style.css" rel="stylesheet"> from the <head> of the root index.html file.
  4. Add <link href="css/indui.app.css" rel="stylesheet"> to the <head> of the root index.html file.
  5. In the indui.project file, add the JavaScript property "gulpStartupTasks": ["sass", "watch"] (this can also be customized to whatever gulp tasks you'd like).

indui.io services

The CLI supports operations to use backend services for your indui app. To get started, visit the indui.io homepage and sign up there.

There are a few things you can utilize the CLI for to support ease of development.

Login

Type indui login to get logged in the CLI.

Login without prompt

You can pass the email and password to login without being prompted for email and password.

indui login --email user@indui.io --password somepass

Login with environment variables

The CLI also supports settings environment variables to read off the email and password for the user.

Set indui_EMAIL and indui_PASSWORD as variables to have the CLI read these instead of being prompted for them.

Upload your indui app

Use the indui upload command to take your current application you are developing and upload it to the indui.io servers.

Now you can use the indui view app to view that application or have others view the application.

After uploading the application, you will see a message:

Uploading app....
 
Successfully uploaded (f23j9fjs)

This indicates you uploaded the application correctly, and the App ID is set to f23j9fjs.

You can then view that App ID from the View app or the application listing on indui.io.

Adding a note with your upload

To add a note to your build, pass the --note option as follows:

indui upload --note "This version of the application fixes the menu selections".

Set your indui Project App ID manually

Use the indui link <appId> command to set your indui App ID to continue working with the same app with the indui platform across development enviroments.

Share the application with another user

Use the indui share <email> command to have an email sent to another person to have them view the indui application you are using. Note: You must have an indui.io account as well as the user you are sharing with.

indui Docs

To get indui documentation from the indui CLI, try using the indui docs command. The command will look up your currently used indui version and open the docs specific for that version. Ex: RC0, RC1, etc.

To view all docs, indui docs ls.

To get help with a doc you may not remember, just type the name close enough: indui docs list and you will be prompted for suggestions that may match.

indui Hooks

indui provides some default hooks for you to use in your Cordova application. In versions prior to 1.3.18, these hooks were automatically installed via the indui platform command.

In 1.3.18, the hooks were automatically removed due to some errors users were having with Crosswalk and other plugins with variables.

If you were a user who would still like to use those hooks, you can re-install these hooks with the indui hooks add command.

If you would like to remove these hooks yourself, use indui hooks remove to get rid of them.

indui State

indui now provides a command to help you manage the state of your indui application. Previously Cordova hooks were used to save platforms and plugins to your package.json file.

Now when using indui platform add, indui platform rm, indui plugin add, or indui plugin rm, the state command will automatically be used to save the platform or plugin state to the package.json file.

If you would like to avoid saving plugins or platforms to the package.json file - pass in the --nosave option. (indui plugin add org.apache.cordova.file --nosave).

Your package.json file might look something like the following:

"cordovaPlatforms"[
  "ios",
  {
    "android": {
      "id": "android",
      "locator": "https://github.com/apache/cordova-android.git"
    }
  }
],
"cordovaPlugins"[
  "org.apache.cordova.device",
  "org.apache.cordova.console",
  "com.indui.keyboard",
  "org.apache.cordova.splashscreen",
  {
    "locator": "https://github.com/MobileChromeApps/cordova-crosswalk-engine.git",
    "id": "org.cordova.croswalk"
  },
  {
    "locator": "/path/to/cloned/phonegap-facebook-plugin",
    "id": "",
    "variables": {
        "APP_ID": "some_id",
        "APP_NAME": "some_name"
    }
  }
]

indui state save

The indui state save command does some lookup in your platforms and plugins to save the current state of your cordova application.

First it looks in your platforms folder to see which platforms are installed, and saves the name and version in your package.json file under the cordovaPlatforms attribute.

Second it looks at your plugins fetch.json file to save the plugins installed both from the Cordova registry, locally installed plugins, as well as remote plugins from github or a remote HTTP url.

indui state restore

The indui state restore command looks at the cordovaPlugins and cordovaPlatforms attributes in your package.json file to restore your application with those platforms and plugins.

In the package.json file, cordovaPlugins will be stored as just their ID if they are installed from the Cordova registry. However, if they are local or remote, they will be stored as an object with those properties. Also to note, variables are stored for plugins with variables like the Facebook connect plugin.

The cordovaPlatforms follow the same convention of either an ID for the platform name, if they are local or remote, they will be stored as an object with those properties.

If you'd like, you can populate the cordovaPlugins and cordovaPlatforms by hand, then use the indui state restore command to get your app ready to go.

indui state clear

The indui state clear method will clear out your platforms and plugins directories, as well as removing the cordovaPlugins and cordovaPlaforms attributes in your package.json file.

indui state reset

The indui state reset method will first remove your platforms and plugins folders. Then it will look at your package.json file to re-install the platforms and plugins as specified there.

This command can be helpful for you to reinstall your plugins and platforms to get a fresh start.

indui CLI 2.0

indui Generators

First class support has come to the indui CLI to scaffold and generate indui and Angular 2 components. To use this feature, first install the V2 indui CLI: npm install indui@alpha and start an app.

Once in the app folder, use the generate command (alias: g).

Usage:

  • indui generate page About - Generate a page named About with HTML, JavaScript, and Sass named about.
  • indui g tabs MyTabPage - Generate a page named MyTabPage, queries for the amount of tabs, and creates pages for those tabs.

List:

View all generators: indui g --list.