Install | NookDocs

The NookDocs CLI ships as a single nookdocs binary on npm. Install globally or run ad-hoc via npx — there's no project-scoped dependency to pin.

Prerequisites

Node.js 18 or later. The CLI is pure ESM and uses modern node:fs and string APIs. Verify:

node --version
# → v18.x.x or later

If Node is missing or stale, install via nodejs.org, nvm, or fnm.

No other runtime dependencies. No config file. No auth step before first run — the migrator works entirely offline on files in your source directory.

Install globally

npm

npm install -g nookdocs

Verify:

nookdocs --help

You should see the command list and supported platforms.

One-off run via npx

No install needed:

npx nookdocs migrate ./my-mintlify-docs

npx downloads the latest version, runs it, and discards. Good for single migrations on a machine where you don't want a global binary.

Upgrade

npm install -g nookdocs@latest

Check installed version with npm list -g nookdocs or by inspecting nookdocs --help output. The CLI doesn't self-update — re-run the install command on releases.

Uninstall

npm uninstall -g nookdocs

Or if installed via pnpm / yarn / bun, use their equivalent uninstall command.

Troubleshooting

What's installed

Global install adds a single nookdocs executable to your npm bin directory. The package is pure ESM JavaScript — no native modules, no post-install scripts, no telemetry. Source is on github.com/Codivion/NookDocs/tree/main/packages/cli for inspection.

Overview — what the CLI does and when to use it
Migrate command — flags, detection, report output
Migrating from Mintlify — end-to-end walkthrough