# crosswalk-app-tools > An APK packager for the Crosswalk Project -- http://crosswalk-project.org Latest version **0.10.5** (published 2017-01-19) · Apache-2.0 license · 0 weekly downloads ## Install ```sh npm install crosswalk-app-tools pnpm add crosswalk-app-tools yarn add crosswalk-app-tools bun add crosswalk-app-tools ``` Provides the commands `crosswalk-app`, `crosswalk-pkg`. ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.10.5 | | Published | 2017-01-19 | | First published | 2015-04-15 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | none | | Module format | CommonJS | | Node | >=0.12 | | Dependencies | 13 | | Known vulnerabilities | 0 (+25 in 7 direct dependencies) | | Install scripts | no | | GitHub stars | 37 | | Author | Robert Staudinger | | Maintainers | baleboy, rakuco | | Keywords | crosswalk, apk, packaging, android | ## Links - npm: https://www.npmjs.com/package/crosswalk-app-tools - Repository: https://github.com/crosswalk-project/crosswalk-app-tools - Homepage: https://github.com/crosswalk-project/crosswalk-app-tools#readme - Issues: https://crosswalk-project.org/jira/ - npm.io page: https://npm.io/package/crosswalk-app-tools ## Dependencies (13) - [uuid](https://npm.io/package/uuid.md) ^3.0.0 - [mktemp](https://npm.io/package/mktemp.md) ~0.3.5 - [xmldom](https://npm.io/package/xmldom.md) ~0.1.19 - [adm-zip](https://npm.io/package/adm-zip.md) ~0.4.4 - [readdir](https://npm.io/package/readdir.md) ~0.0.13 - [shelljs](https://npm.io/package/shelljs.md) ~0.3.0 - [minimist](https://npm.io/package/minimist.md) ~1.1.0 - [mustache](https://npm.io/package/mustache.md) ~0.8.2 - [xmlbuilder](https://npm.io/package/xmlbuilder.md) ~2.6.4 - [format-json](https://npm.io/package/format-json.md) ~1.0.3 - [parse-color](https://npm.io/package/parse-color.md) ~1.0.0 - [memorystream](https://npm.io/package/memorystream.md) ~0.3.0 - [https-proxy-agent](https://npm.io/package/https-proxy-agent.md) ~0.3.5 ## Alternatives - [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads - [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads - [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads - [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads - [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads ## Recent versions - 0.10.5 (latest) — 2017-01-19 - 0.10.4 — 2016-06-07 - 0.10.3 — 2016-04-18 - 0.10.2 — 2016-03-21 - 0.10.1 — 2016-03-08 - 0.10.0 — 2016-03-08 - 0.9.1 — 2015-12-17 - 0.9.0 — 2015-12-17 - 0.8.1 — 2015-12-17 - 0.8.0 — 2015-11-06 - 0.7.2 — 2015-10-21 - 0.7.1 — 2015-10-21 - 0.7.0 — 2015-10-21 - 0.6.1 — 2015-08-05 - 0.6.0 — 2015-08-05 - … 9 more at https://npm.io/package/crosswalk-app-tools/versions ## README Crosswalk-app-tools =================== Crosswalk-app-tools is our forthcoming packaging tool for creating Crosswalk applications. We are inviting early adopters to build their web applications using crosswalk-app-tools, and provide feedback for future improvements. ### Installation The tools are cross-platform by virtue of being based on Node.js. We are supporting Microsoft Windows, Apple OS X and Linux as host operating systems. The following components are required * Node.js and NPM * Android development (APK packages): Android SDK with 5.0 (target-21) or later installed, plus Java JDK and Apache Ant. Supported host systems are Apple OS X, Linux, and Windows. * Windows development (MSI packages): [WiX Toolset](http://wixtoolset.org). MSI installers can only be created on Windows systems. In order to get the tools available from the command-line easily, global npm installation is recommended. Microsoft Windows: `npm install -g crosswalk-app-tools` Apple OS X and Linux: `sudo npm install -g crosswalk-app-tools` The best way to check if a machine has all the required dependencies is to create and build a plain empty Android app on the system. If this does not work, then building Crosswalk apps will not succeed either. App-tools provides a command for doing this: Check Android target setup: ``` crosswalk-app check android ``` Check Windows target setup: ``` crosswalk-app check windows ``` Two executables are provided, `crosswalk-app` implements low level helper commands, `crosswalk-pkg` is the main tool for creating packages. ### Usage (crosswalk-pkg --help) ``` Crosswalk Project Packaging Tool -- https://crosswalk-project.org Usage: crosswalk-pkg -a --android= Extra configurations for Android -c --crosswalk= Specify Crosswalk version or path -h --help Print usage information -k --keep Keep build tree for debugging -m --manifest= Fill manifest.json with default values -p --platforms= Specify target platform -r --release Build release packages -s --skip-check Skip host setup check before building -t --targets= Target CPU architectures -v --version Print tool version -w --windows= Extra configurations for Windows Path to directory that contains a web app Quoted string with extra config, e.g. "shared" * "shared" Build APK that depends on crosswalk in the Google Play Store * "lite" Use crosswalk-lite, see Crosswalk Wiki Canonical application name, e.g. com.example.foo, needs to * Comprise of 3 or more period-separated parts * Begin with lowecase letters List of CPU architectures for which to create packages. Currently supported ABIs are: armeabi-v7a, arm64-v8a, x86, x86_64 * Prefixes will be matched, so "a","ar", or "arm" yield both ARM APKs * Same for "x" and "x8", but "x86" is an exact match, only x86-32 conforms * Short-hands "32" and "64" build ARM and x86 for the requested word size * Default behavior is equivalent to "32", creation of 32-bit installers Example: --targets="arm x86" builds both ARM plus 32-bit x86 packages List of operating systems for which to create packages. Default is android-only, which is supported on Apple OSX, Linux and Windows Creating Windows MSIs is supported on Microsoft Windows only. Example: --platforms="android windows" * Channel name, i.e. stable/beta/canary * Version number, e.g. 14.43.343.25 * Path to release, e.g. $HOME/Downloads/crosswalk-14.43.343.25.zip * Path to build, e.g. crosswalk/src/out/Release/xwalk_app_template When passing a local file or directory, only the contained ABIs can be built. See for details. Quoted string with extra config, e.g. "google-api-key:" where is the keyset in ~/.crosswalk-app-tools-keys.json Environment variables CROSSWALK_APP_TOOLS_CACHE_DIR=: Keep downloaded files in this dir ``` ### Example: Creating and packaging an application To get started, all you need is a web manifest, and an html file. The web manifest holds name and settings for your application. A minimal manifest.json looks like this: ``` { "name": "My first Crosswalk application", "start_url": "index.html", "xwalk_package_id": "com.example.foo" } ``` Then add an index.html in the same directory: ``` My first Crosswalk application This is my first Crosswalk application ``` Finally, time to create the APK package: ``` crosswalk-pkg ``` Creation of an MSI package on Windows: ``` crosswalk-pkg -p windows ``` This sets up a skeleton project, downloads and imports Crosswalk, and creates a package using the files above. ### Next steps and limitations * Android release packages will have to be signed manually before they are published on Google's Play Store, as that functionality is not yet integrated. See https://developer.android.com/tools/publishing/app-signing.html#signing-manually for details. * We encourage everyone to use this app-tools and appreciate feedback, as we are looking to improve user friendliness and integration with Crosswalk in the coming releases. ### Additional target platforms There is forthcoming support for additional target platforms. For iOS packaging, see https://github.com/crosswalk-project/crosswalk-app-tools-ios. ### Run development versions from git 1. Download: `npm install https://github.com/crosswalk-project/crosswalk-app-tools.git` 4. The main script is `crosswalk-app-tools/src/crosswalk-pkg`. Set environment PATH or invoke with directory. ### License The license for this project is the Apache License Version 2.0, please refer to the LICENSE-APACHE-V2 included with the package for details. --- _Source: https://npm.io/package/crosswalk-app-tools · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._