18c339a94Sopenharmony_ci# Checker Tool
28c339a94Sopenharmony_ci
38c339a94Sopenharmony_ci**node-addon-api** provides a [checker tool][] that will inspect a given
48c339a94Sopenharmony_cidirectory tree, identifying all Node.js native addons therein, and further
58c339a94Sopenharmony_ciindicating for each addon whether it is an Node-API addon.
68c339a94Sopenharmony_ci
78c339a94Sopenharmony_ci## To use the checker tool:
88c339a94Sopenharmony_ci
98c339a94Sopenharmony_ci  1. Install the application with `npm install`.
108c339a94Sopenharmony_ci
118c339a94Sopenharmony_ci  2. If the application does not depend on **node-addon-api**, copy the
128c339a94Sopenharmony_ci     checker tool into the application's directory.
138c339a94Sopenharmony_ci
148c339a94Sopenharmony_ci  3. If the application does not depend on **node-addon-api**, run the checker
158c339a94Sopenharmony_ci     tool from the application's directory:
168c339a94Sopenharmony_ci
178c339a94Sopenharmony_ci     ```sh
188c339a94Sopenharmony_ci     node ./check-napi.js
198c339a94Sopenharmony_ci     ```
208c339a94Sopenharmony_ci
218c339a94Sopenharmony_ci     Otherwise, the checker tool can be run from the application's
228c339a94Sopenharmony_ci     `node_modules/` subdirectory:
238c339a94Sopenharmony_ci
248c339a94Sopenharmony_ci     ```sh
258c339a94Sopenharmony_ci     node ./node_modules/node-addon-api/tools/check-napi.js
268c339a94Sopenharmony_ci     ```
278c339a94Sopenharmony_ci
288c339a94Sopenharmony_ciThe tool accepts the root directory from which to start checking for Node.js
298c339a94Sopenharmony_cinative addons as a single optional command line parameter. If omitted it will
308c339a94Sopenharmony_cistart checking from the current directory (`.`).
318c339a94Sopenharmony_ci
328c339a94Sopenharmony_ci[checker tool]: ../tools/check-napi.js
33