Crosswalk-app-tools
Command line tools to create and package Crosswalk applications. The license for this project is Apache License
Version 2.0, please refer to the LICENSE-APACHE-V2 included with the package.
Crosswalk-app-tools is in very early stages of development, and not suitable for use in a production environment. "Releases" and announcements are made available as a technology preview only. No packages are being published at this time, but git tags serve as reference points for release milestones.
Installation
Prerequisites are functional
- Android SDK
- Apache Ant
- Node.js
on the system.
In order to get the crosswalk-app
script available everywhere, global npm installation is required. On most Linux distributions this can be achieved by using sudo
.
sudo npm install -g crosswalk-app-tools
Usage
Crosswalk Application Project and Packaging Tool
crosswalk-app create <package-id> Create project <package-id>
--crosswalk=<path> Use downloaded Crosswalk
--channel=<name> Release channel: stable|beta|canary
crosswalk-app build [release|debug] Build project to create packages
Defaults to debug when not given
crosswalk-app update <channel>|<version> Update Crosswalk to latest in named
channel, or specific version
crosswalk-app help Display usage information
crosswalk-app version Display version information
Example: Create App
crosswalk-app create com.example.foo
: This sets up a skeleton project in directory com.example.foo/, downloads and imports Crosswalk, and puts a sample "hello world" web app under com.example.foo/app/.
Example: Build App
cd com.example.foo
and then crosswalk-app build
builds packages. The APKs can be found under pkg/ when done.
Example: Update Crosswalk
crosswalk-app update stable
updates Crosswalk to the latest version available in the stable channel.
Limitations
- This is alpha stage software and under continuous development. We encourage trying it and appreciate feedback, but use in a production environment is not supported at this point in time.
- A problem prevents use with anyting but releases from the "stable" crosswalk channel.
Run development versions from git
- Download:
git clone https://github.com/crosswalk-project/crosswalk-app-tools.git
- Install dependencies:
cd crosswalk-app-tools
, then npm install
, and cd ..
- The main script is
crosswalk-app-tools/src/crosswalk-app
. Set environment PATH or invoke with directory.