Getting Started

Requirements

Knip v3 requires Node.js v18.6 or higher. Or Bun.

Installation

The recommended way to install Knip is by using your package manager:

npm

npm install -D knip typescript @types/node

pnpm

pnpm add -D knip typescript @types/node

bun

bun add -D knip typescript @types/node

yarn

yarn add -D knip typescript @types/node

Knip uses typescript and @types/node as peer dependencies to increase compatibility with your project (they are likely already in your node_modules anyway).

Add a knip script to your package.json:

package.json

{
  "name": "my-project",
  "scripts": {
    "knip": "knip"
  }
}

Run Knip

Now you can run Knip to lint your project:

npm

npm run knip

pnpm

pnpm knip

bun

bun knip

yarn

yarn knip

Knip will lint your project and output unused files, dependencies and exports.

Without Installation

Alternatively, try Knip without adding it to your project:

npm

npx knip

pnpm

pnpm dlx knip

bun

bunx knip