Node.js native addon build tool
node-gyp is a cross-platform command-line tool written in Node.js for compiling
native addon modules for Node.js, which takes away the pain of dealing with the
various differences in build platforms.
Multiple target versions of node are supported (i.e.
even if those versions of node are not installed on your system (
downloads the necessary development files for the target version).
- Easy to use, consistent interface
- Same commands to build your module on every platform
- Supports multiple target versions of Node
To install with
$ npm install -g node-gyp
You will also need to install:
- On Unix
- A proper C/C++ compiler toolchain, like GCC
- On Windows
How to Use
To compile your native addon, first go to its root directory:
$ cd my_node_addon
From here, you can invoke the
node-gyp executable. The next step is to generate
the appropriate project build files for the current platform. Use
$ node-gyp configure --target=0.7
Now you will have either a
Makefile (on Unix platforms) or a
vcxproj file (on Windows) in the current directory. Next invoke the
$ node-gyp build
Now you have your compiled
.node bindings file! The compiled bindings end up in
out/Release, depending on the build mode. At this point you can
.node file with Node and run your tests!
(Optional) Copy the compiled bindings into an appropriate directory for
runtime loading detection (with node-bindings), using the
$ node-gyp copy
So for example, if you are on a 64-bit OS X machine and your target node version
0.7, then the
copy command above would copy the bindings from
node-gyp responds to the following commands:
msbuild.exeand builds the native addon
clean- Removes any generated project files and the
configure- Generates project build files for the current platform
copy- Copies a compiled bindings to an appropriate dir for runtime detection
install- Installs node development files for the given version
(The MIT License)
Copyright (c) 2012 Nathan Rajlich <firstname.lastname@example.org>
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.