# weex-buildtool > Weex build Toolkit Latest version **0.0.1** (published 2016-08-25) · GPL-3.0+ license · 0 weekly downloads ## Install ```sh npm install weex-buildtool pnpm add weex-buildtool yarn add weex-buildtool bun add weex-buildtool ``` Provides the command `weex-buildtool`. ## 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.0.1 | | Published | 2016-08-25 | | First published | 2016-08-25 | | Weekly downloads | 0 | | License | GPL-3.0+ | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 40 | | Known vulnerabilities | 0 (+9 in 7 direct dependencies) | | Install scripts | no | | GitHub stars | 10 | | Author | xuxinxin | | Maintainers | starow | ## Links - npm: https://www.npmjs.com/package/weex-buildtool - Repository: https://github.com/Icemic/weex-buildtool - Homepage: https://github.com/Icemic/weex-buildtool#readme - Issues: https://github.com/Icemic/weex-buildtool/issues - npm.io page: https://npm.io/package/weex-buildtool ## Dependencies (40) - [co](https://npm.io/package/co.md) ^4.6.0 - [ws](https://npm.io/package/ws.md) ^1.1.0 - [vue](https://npm.io/package/vue.md) ^1.0.24 - [glob](https://npm.io/package/glob.md) ^7.0.5 - [path](https://npm.io/package/path.md) ^0.12.7 - [uuid](https://npm.io/package/uuid.md) ^2.0.2 - [async](https://npm.io/package/async.md) ^2.0.1 - [debug](https://npm.io/package/debug.md) ^2.2.0 - [plist](https://npm.io/package/plist.md) ^1.2.0 - [unzip](https://npm.io/package/unzip.md) ^0.1.11 - [yargs](https://npm.io/package/yargs.md) ^3.32.0 - [adbkit](https://npm.io/package/adbkit.md) ^2.5.1 - [colors](https://npm.io/package/colors.md) ^1.1.2 - [events](https://npm.io/package/events.md) ^1.1.0 - [images](https://npm.io/package/images.md) ^3.0.0 - [npmlog](https://npm.io/package/npmlog.md) ^2.0.4 - [opener](https://npm.io/package/opener.md) ^1.4.1 - [xml2js](https://npm.io/package/xml2js.md) ^0.4.17 - [homedir](https://npm.io/package/homedir.md) ^0.6.0 - [promise](https://npm.io/package/promise.md) ^7.1.1 - [webpack](https://npm.io/package/webpack.md) ^1.13.1 - [bluebird](https://npm.io/package/bluebird.md) ^3.4.1 - [download](https://npm.io/package/download.md) ^5.0.2 - [fs-extra](https://npm.io/package/fs-extra.md) ^0.30.0 - [inquirer](https://npm.io/package/inquirer.md) ^1.1.2 - [commander](https://npm.io/package/commander.md) ^2.9.0 - [sync-exec](https://npm.io/package/sync-exec.md) ~0.6.2 - [validator](https://npm.io/package/validator.md) ^5.5.0 - [ios-deploy](https://npm.io/package/ios-deploy.md) ^1.8.6 - [node-watch](https://npm.io/package/node-watch.md) ^0.3.5 - [properties](https://npm.io/package/properties.md) ^1.2.1 - [underscore](https://npm.io/package/underscore.md) ^1.8.3 - [weex-html5](https://npm.io/package/weex-html5.md) ^0.2.23-beta - [http-server](https://npm.io/package/http-server.md) ^0.9.0 - [weex-loader](https://npm.io/package/weex-loader.md) ^0.1.5 - [babel-runtime](https://npm.io/package/babel-runtime.md) ^6.6.1 - [harmony-reflect](https://npm.io/package/harmony-reflect.md) ^1.4.6 - [qrcode-terminal](https://npm.io/package/qrcode-terminal.md) ^0.10.0 - [vinyl-source-stream](https://npm.io/package/vinyl-source-stream.md) ^1.1.0 - [babel-plugin-transform-runtime](https://npm.io/package/babel-plugin-transform-runtime.md) ^6.7.5 ## Recent versions - 0.0.1 (latest) — 2016-08-25 ## README # Readme [TOC] ## Installation ### Nodejs Please make sure you have `Nodejs` installed. `v6.x` is recommended while `v4.x` is the minimium supported version. ### node-gyp if your ```shell $ node-gyp --version ``` output less then `3.4.0` or no node-gpy installed in your system , please run below cmd to install or upgrade `node-gyp` ```shell $ npm install -g node-gyp ``` ### Install ``` $ npm install -g weex-buildtool ``` ### Android To generate a Android `.apk` file, there are several steps you should follow, [SEE MORE](https://github.com/Icemic/weex-buildtool/wiki/android-env). ### iOS To generate a iOS `.ipa` or `.app` file, there are several steps you should follow, [SEE MORE](https://github.com/Icemic/weex-buildtool/wiki/ios-env). ## Quick Start Initial your weex project and download dependencies. ```shell $ weex init && npm install ``` Then, initial build project ```shell $ weex-buildtool build init ``` Build iOS package and run in a real device or simulator. (as well as Android) ```shell $ weex-buildtool run ios ``` ## Handbook ### Commands ```shell # init $ weex-buildtool build init [android|ios|all] [-u url] # build, genrate a apk/ipa/app package, default to -r $ weex-buildtool build [android|ios|html|all] [-d|-r] # emulate, run the package in real device or simulator, default to -d $ weex-buildtool emulate [android|ios|html|all] [-d|-r] # run, equals to build&emulate, default to -d $ weex-buildtool run [android|ios|html] [-d|-r] # tips: -d, debug | -r, release # -u url, specific a third party template project, # see http://xxxxx ``` ### Custom Package Infomation You can custom package name, app name, icon, splash, etc. as you want at `config/config..js`. [See more about configuration](https://github.com/Icemic/weex-buildtool/wiki/user-configure). ### Certificate & Signature Certificate and signature are supported in release package. Make sure you have owned a valid cert or keystore, and edit `config/config..js`. [See more about configuration](https://github.com/Icemic/weex-buildtool/wiki/user-configure). ### Custom Android/iOS Native Code While a default native project are provided, you can also custom it or create a completely new one for more amazing purpose! However, you must obey some rules, [for Android](https://github.com/Icemic/weex-buildtool/wiki/AndroidTemplateExtendProject), [for iOS](https://github.com/Icemic/weex-buildtool/wiki/Iostemplateextendproject). Our default project are hosting at [Android](https://github.com/liujiescut/WeexAndroidTemplate) [iOS](https://github.com/VeHan/Weex-Pakeex-iOS-Template), you can fork and custom without limitation. --- _Source: https://npm.io/package/weex-buildtool · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._