1# Checker Tool
2
3**node-addon-api** provides a [checker tool][] that will inspect a given
4directory tree, identifying all Node.js native addons therein, and further
5indicating for each addon whether it is an Node-API addon.
6
7## To use the checker tool:
8
9  1. Install the application with `npm install`.
10
11  2. If the application does not depend on **node-addon-api**, copy the
12     checker tool into the application's directory.
13
14  3. If the application does not depend on **node-addon-api**, run the checker
15     tool from the application's directory:
16
17     ```sh
18     node ./check-napi.js
19     ```
20
21     Otherwise, the checker tool can be run from the application's
22     `node_modules/` subdirectory:
23
24     ```sh
25     node ./node_modules/node-addon-api/tools/check-napi.js
26     ```
27
28The tool accepts the root directory from which to start checking for Node.js
29native addons as a single optional command line parameter. If omitted it will
30start checking from the current directory (`.`).
31
32[checker tool]: ../tools/check-napi.js
33