Getting Started

Requirements

Knip v5 requires at least Node.js v18.18.0. Or Bun.

Want to try Knip without installation? Visit the playground.

Installation

This is the easiest and recommended way to install Knip:

npm

npm init @knip/config

pnpm

pnpm create @knip/config

bun

bun create @knip/config

yarn

yarn create @knip/config

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 report unused dependencies, exports and files.

If the output makes sense to you, feel free to go to the next page: configuration.

Too Much?

In large or complex codebases the output might be overwhelming. Start by limiting the number of shown issues per type:

npm

npm run knip -- --max-show-issues 5

pnpm

pnpm knip --max-show-issues 5

bun

bun knip --max-show-issues 5

yarn

yarn knip --max-show-issues 5

The output is easier to digest and may include some configuration hints to get an idea of what’s left to configure. Many unused files? Go to configuration and follow up with troubleshooting if needed.

Tip

Do not use the ignore option just to get rid of unwanted output. Read Configuring Project Files to get the most out of Knip.

Manual

Alternatively, manually install Knip 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. No worries, they’re probably in your node_modules already.

Then add a knip script to your package.json:

package.json

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

Without installation

To run Knip without adding it to your project:

npm

npx knip

pnpm

pnpm dlx knip

bun

bunx knip

In this scenario typescript and @types/node are expected to be installed already.