node-webkit native addon build tool
nw-gyp is a hack on
node-gyp to build native modules for node-webkit. We are
trying to provide a smooth way for developers rather than specifying a lot of
command line arguments.
It supports node-webkit starts from v0.3.2 and users need to manually specify the version of node-webkit currently.
You can install with
$ npm install -g nw-gyp
You will also need to install:
v3.x.xis not supported)
v3.x.xis not supported)
Note that OS X is just a flavour of Unix and so needs
make, and C/C++.
An easy way to obtain these is to install XCode from Apple,
and then use it to install the command line tools (under Preferences -> Downloads).
To compile your native addon, first go to its root directory:
$ cd my_node_addon
The next step is to generate the appropriate project build files for the current
configure for that:
$ nw-gyp configure --target=<0.3.2 or other nw version>
configure step looks for the
binding.gyp file in the current
directory to processs. See below for instructions on creating the
Now you will have either a
Makefile (on Unix platforms) or a
(on Windows) in the
build/ directory. Next invoke the
$ nw-gyp build
Now you have your compiled
.node bindings file! The compiled bindings end up
build/Release/, depending on the build mode. At this point
you can require the
.node file with Node and run your tests!
Note: To create a Debug build of the bindings file, pass the
-d) switch when running the either
Note: nw.js is packed with Node.js version 0.11.13 and a different version of V8 (184.108.40.206) than the one Node.js 0.11.13 has (220.127.116.11), it might lead to some inconsistent behaviour when building your native modules (see rvagg/nan#285).
Previously when node had
node-waf you had to write a
wscript file. The
replacement for that is the
binding.gyp file, which describes the configuration
to build your module in a JSON-like format. This file gets placed in the root of
your package, alongside the
gyp file appropriate for building a node addon looks like:
Some additional resources for writing
nw-gyp responds to the following commands:
||Removes any the
||Generates project build files for the current platform|
||Runs "clean", "configure" and "build" all in a row|
||Installs node development header files for the given version|
||Lists the currently installed node development file versions|
||Removes the node development header files for the given version|
(The MIT License)
Copyright (c) 2012 Nathan Rajlich <email@example.com>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.