tabris-cli

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
• 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] [path]

Starts a server the Tabris.js developer app can be pointed to.

path

The file or directory to serve the Tabris.js app from. When ommitted, the current working directory is served.

options

-l, --logging

Enables request logging.

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

platform

One of ios, android or windows.

options

Default options:

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

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

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

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

Uses same parameters as tabris build.

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

tabris clean

Removes build artifacts.

License

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

Changelog

2.0.0

The serve command now checks for a valid package.json file.

The build command now downloads the native platforms automatically and keeps them in a cache. The environment variables TABRIS_ANDROID_PLATFORM, TABRIS_IOS_PLATFORM, and TABRIS_WINDOWS_PLATFORM are not needed anymore. Please unset these variables to enable the download.

To download the platforms, the CLI will now ask for your build key. This key is available on tabrisjs.com. Once entered, the key is stored in ~/.tabris-cli/build.key.