tabris-cli v3.0.0-beta1-dev.20181128

Tabris.js CLI

The super tool for Tabris.js developers.

Table of Contents

• Installation
• Commands
  • tabris init
  • tabris serve [options] [path]
  • tabris build [options] <platform> [cordova-platform-opts...]
  • tabris run [options] <platform> [cordova-platform-opts...]
  • tabris clean
  • Common tabris run and tabris build parameters
• License

Installation

npm install -g tabris-cli

Commands

tabris init

Creates a new Tabris.js app in the current directory.

See: Quick Start Guide - Tabris.js Documentation

tabris serve [options]

Starts a server the Tabris.js developer app can be pointed to. If a build script is present in package.json, it is executed beforehand.

options

-p [path], --project [path]

The directory to serve the Tabris.js app from. Needs to contain a package.json and installed "tabris" module. When omitted, the current working directory is served.

-m [module], --main [module]

Overrides the "main" field of package.json. The argument must be a valid module id relative to the project root, e.g. "dist/main.js".

-a, --auto-reload

Auto reload the application when a source file is modified.

-i, --interactive

Enable interactive console for JavaScript input.

-l, --logging

Enables request logging.

-w, --watch

Executes the watch instead of the build script given in the package.json of the app before serving. The watch script can be a long-running task.

tabris build [options] <platform> [cordova-platform-opts]

Builds a Tabris.js app for the given platform.

To speed up the build, pre-compiled build artifacts are kept in a build cache and are reused in subsequent builds. To clean up the build cache, e.g. after updating Cordova plug-ins, run tabris clean.

See: Building a Tabris.js app - Tabris.js Documentation

See: Common tabris run and tabris build parameters

tabris run [options] <platform> [cordova-platform-opts]

Builds a Tabris.js app and runs it on a connected device or emulator.

See: Building a Tabris.js app - Tabris.js Documentation

See: Common tabris run and tabris build parameters

options

--target <id>

The ID of the target device to deploy the app to. See --list-targets.

--list-targets

Show a list of available targets to use with --target <id>.

tabris clean

Removes build artifacts.

Common tabris run and tabris build parameters

platform

ios or android.

options

Default options:

• --debug
• --cordova-build-config=./build.json

Note: when neither --emulator nor --device is specified and a device is connected, the app will be built for a device. If no device is connected, the app will be built for an emulator.

--variables <replacements>

Comma-separated list of variable replacements in config.xml. --variables FOO=bar,BAK=baz will replace all occurrences of $FOO and $BAK in config.xml with respectively bar and baz.

Note: per default all environment variables are replaced in config.xml. To prevent that, use the --no-replace-env-vars option.

--cordova-build-config <path>

Path to a build configuration file passed to Cordova. Relative to the cordova/ directory.

See Cordova platform documentation (iOS, Android) for more information about the file format.

You may want to include this file in .gitignore since it may contain sensitive information.

--debug

Perform a debug build. Used for development.

--release

Perform a release build. Used when building apps for the marketplace of their platform.

--emulator

Build the app for an emulator.

--device

Build the app for a device.

--no-replace-env-vars

Do not replace environment variables in config.xml.

See --variables documentation for more information about variable replacement in config.xml.

--verbose

Print more verbose output.

cordova-platform-opts

Platform-specific options passed to Cordova.

See: Platform-specific options - Cordova CLI Reference

License

Published under the terms of the BSD 3-Clause License.