@knip/mcp 0.0.20 → 0.0.21

package/src/docs/docs/reference/jsdoc-tsdoc-tags.md

@@ -0,0 +1,133 @@
+---
+title: JSDoc & TSDoc Tags
+---
+
+JSDoc or TSDoc tags can be used to make exceptions for unused or duplicate
+exports.
+
+Knip tries to minimize configuration and introduces no new syntax. That's why it
+hooks into JSDoc and TSDoc tags.
+
+:::caution
+
+Adding tags or excluding a certain type of issues from the report is usually not
+recommended. It hides issues, which is often a sign of code smell or ambiguity
+and ends up harder to maintain. It's usually better to refactor the code (or
+report an issue with Knip for false positives).
+
+:::
+
+JSDoc comments always start with `/**` (not `//`) and can be single or
+multi-line.
+
+## Tags
+
+Use arbitrary [tags][1] to exclude or include tagged exports from the report.
+Example:
+
+```ts
+/** @lintignore */
+export const myUnusedExport = 1;
+
+/** @lintignore */
+import Unresolved from "./generated/lib.js";
+```
+
+And then include (`+`) or exclude (`-`) these tagged exports from the report
+like so:
+
+```shell
+knip --tags=-lintignore,-internal
+```
+
+Tags can also be [configured in `knip.json`][2].
+
+When an excluded tag is no longer necessary because the export is actually used,
+Knip reports a **tag hint**:
+
+```sh
+Tag hints (1)
+ignored  unimported.ts  Unused tag in unimported.ts: ignored → @custom
+```
+
+This helps you clean up tags that were added to suppress issues that have since
+been resolved.
+
+## `@public`
+
+By default, Knip reports unused exports in non-entry files.
+
+Tag the export as `@public` and Knip will not report it.
+
+Example:
+
+```ts
+/**
+ * @public
+ */
+export const unusedFunction = () => {};
+```
+
+This tag can also be used to make exceptions in entry files when using
+[--include-entry-exports][3].
+
+[JSDoc: @public][4] and [TSDoc: @public][5]
+
+## `@internal`
+
+Internal exports are not meant for public consumption, but only for internal
+usage such as tests. This means they would be reported in [production mode][6].
+
+Mark the export with `@internal` and Knip will not report the export in
+production mode.
+
+Example:
+
+```ts
+/** @internal */
+export const internalTestedFunction = () => {};
+```
+
+In general it's not recommended to expose and test implementation details, but
+exceptions are possible. Those should not be reported as false positives, so
+when using production mode you'll need to help Knip out by tagging them as
+`@internal`.
+
+[TSDoc: @internal][7]
+
+## `@alias`
+
+Knip reports duplicate exports. To prevent this, tag one of the exports as
+`@alias`.
+
+Example:
+
+```ts
+export const Component = () => {};
+
+/** @alias */
+export default Component;
+```
+
+An alternative solution is to use `--exclude duplicates` and exclude all
+duplicates from being reported.
+
+[JSDoc: @alias][8]
+
+## `@beta`
+
+Works identical to [`@public`][9]. Knip ignores other tags like `@alpha` and
+`@experimental`.
+
+[TSDoc: @beta][10]
+
+[1]: ../reference/cli.md#--tags
+[2]: ./configuration.md#tags
+[3]: ./cli.md#--include-entry-exports
+[4]: https://jsdoc.app/tags-public.html
+[5]: https://tsdoc.org/pages/tags/public/
+[6]: ../features/production-mode.md
+[7]: https://tsdoc.org/pages/tags/internal/
+[8]: https://jsdoc.app/tags-alias.html
+[9]: #public
+[10]: https://tsdoc.org/pages/tags/beta/

package/src/docs/docs/reference/known-issues.md

@@ -0,0 +1,86 @@
+---
+title: Known Issues
+---
+
+List of known issues and workarounds for exceptions thrown during a Knip run.
+
+See [handling issues][1] to learn more about dealing with lint issues.
+
+## Exceptions from config files
+
+An exception may be thrown when a Knip plugin loads a JavaScript or TypeScript
+configuration file such as `webpack.config.js` or `vite.config.ts`:
+
+```sh
+$ knip
+Error loading .../vite.config.ts
+```
+
+Knip may load such files differently, in a different environment, with missing
+environment variables, missing path aliases, etcetera. Use `--debug` to locate
+the cause of the issue with more details.
+
+Potential workarounds:
+
+- [Set path aliases][2] for "Cannot find module" errors
+- Set missing environment variable(s), potential solutions:
+  - Use a helper package like [dotenvx][3]
+  - `KEY=VAL knip`
+  - `node --env-file .env $(which knip)`
+- Disable loading the file by overriding the default `config` for that plugin.
+  - Example: `vite: { config: [] }`
+  - In a monorepo, be more specific like so:
+    `workspaces: { "packages/lib": { vite: { config: [] } } }`
+  - If this helps, add the file as an `entry` file for static analysis.
+- Disable the related plugin.
+  - Example: `eslint: false`
+  - In a monorepo, be more specific like so:
+    `workspaces: { "packages/lib": { eslint: false } }`
+  - If this helps, add the file as an `entry` file for static analysis.
+- As a last resort, ignore the workspace: `ignoreWorkspaces: ["packages/lib"]`.
+
+## Path aliases in config files
+
+Loading the configuration file (e.g. `cypress.config.ts`) for one of Knip's
+plugins may give an error:
+
+```sh
+$ knip
+Analyzing workspace ....
+Error loading .../cypress.config.ts
+Reason: Cannot find module '@alias/name'
+Require stack:
+- .../cypress.config.ts
+```
+
+Some tools (such as Cypress and Jest) support using TypeScript path aliases in
+the configuration file.
+
+Potential workarounds:
+
+- Rewrite the import in the configuration file to a relative import.
+- Inject support with a module like `tsx`: `NODE_OPTIONS="--import tsx" knip`
+- Or `tsconfig-paths`: `NODE_OPTIONS="--import tsconfig-paths/register.js" knip`
+- Use Bun with [knip-bun][4].
+- See [exceptions from config files][5] for more potential workarounds.
+
+## Nx Daemon
+
+In Nx projects you might encounter this error:
+
+```sh
+NX   Daemon process terminated and closed the connection
+```
+
+The solution is to [disable the Nx Daemon][6]:
+
+```sh
+NX_DAEMON=false knip
+```
+
+[1]: ../guides/handling-issues.mdx
+[2]: #path-aliases-in-config-files
+[3]: https://dotenvx.com/
+[4]: ./cli.md#knip-bun
+[5]: #exceptions-from-config-files
+[6]: https://nx.dev/concepts/nx-daemon#turning-it-off

package/src/docs/docs/reference/plugins.md

@@ -0,0 +1,146 @@
+---
+title: Plugins (137)
+tableOfContents: false
+---
+
+:::section{.columns.min200}
+- [Angular](/reference/plugins/angular "Angular")
+- [Astro](/reference/plugins/astro "Astro")
+- [Astro DB](/reference/plugins/astro-db "Astro DB")
+- [astro-og-canvas](/reference/plugins/astro-og-canvas "astro-og-canvas")
+- [Ava](/reference/plugins/ava "Ava")
+- [Babel](/reference/plugins/babel "Babel")
+- [Biome](/reference/plugins/biome "Biome")
+- [bumpp](/reference/plugins/bumpp "bumpp")
+- [Bun](/reference/plugins/bun "Bun")
+- [c8](/reference/plugins/c8 "c8")
+- [Capacitor](/reference/plugins/capacitor "Capacitor")
+- [Changelogen](/reference/plugins/changelogen "Changelogen")
+- [Changelogithub](/reference/plugins/changelogithub "Changelogithub")
+- [Changesets](/reference/plugins/changesets "Changesets")
+- [Commitizen](/reference/plugins/commitizen "Commitizen")
+- [commitlint](/reference/plugins/commitlint "commitlint")
+- [Convex](/reference/plugins/convex "Convex")
+- [create-typescript-app](/reference/plugins/create-typescript-app "create-typescript-app")
+- [CSpell](/reference/plugins/cspell "CSpell")
+- [Cucumber](/reference/plugins/cucumber "Cucumber")
+- [Cypress](/reference/plugins/cypress "Cypress")
+- [Danger](/reference/plugins/danger "Danger")
+- [dependency-cruiser](/reference/plugins/dependency-cruiser "dependency-cruiser")
+- [Docusaurus](/reference/plugins/docusaurus "Docusaurus")
+- [dotenv](/reference/plugins/dotenv "dotenv")
+- [Drizzle](/reference/plugins/drizzle "Drizzle")
+- [Eleventy](/reference/plugins/eleventy "Eleventy")
+- [ESLint](/reference/plugins/eslint "ESLint")
+- [execa](/reference/plugins/execa "execa")
+- [Expo](/reference/plugins/expo "Expo")
+- [Expressive Code](/reference/plugins/expressive-code "Expressive Code")
+- [Gatsby](/reference/plugins/gatsby "Gatsby")
+- [GitHub Action](/reference/plugins/github-action "GitHub Action")
+- [GitHub Actions](/reference/plugins/github-actions "GitHub Actions")
+- [glob](/reference/plugins/glob "glob")
+- [GraphQL Codegen](/reference/plugins/graphql-codegen "GraphQL Codegen")
+- [Hardhat](/reference/plugins/hardhat "Hardhat")
+- [husky](/reference/plugins/husky "husky")
+- [i18next Parser](/reference/plugins/i18next-parser "i18next Parser")
+- [Jest](/reference/plugins/jest "Jest")
+- [Karma](/reference/plugins/karma "Karma")
+- [Knex](/reference/plugins/knex "Knex")
+- [Ladle](/reference/plugins/ladle "Ladle")
+- [Lefthook](/reference/plugins/lefthook "Lefthook")
+- [lint-staged](/reference/plugins/lint-staged "lint-staged")
+- [LintHTML](/reference/plugins/linthtml "LintHTML")
+- [lockfile-lint](/reference/plugins/lockfile-lint "lockfile-lint")
+- [Lost Pixel](/reference/plugins/lost-pixel "Lost Pixel")
+- [markdownlint](/reference/plugins/markdownlint "markdownlint")
+- [MDX](/reference/plugins/mdx "MDX")
+- [mdxlint](/reference/plugins/mdxlint "mdxlint")
+- [Metro](/reference/plugins/metro "Metro")
+- [Mocha](/reference/plugins/mocha "Mocha")
+- [moonrepo](/reference/plugins/moonrepo "moonrepo")
+- [Mock Service Worker](/reference/plugins/msw "Mock Service Worker")
+- [Nano Staged](/reference/plugins/nano-staged "Nano Staged")
+- [Nest](/reference/plugins/nest "Nest")
+- [Netlify](/reference/plugins/netlify "Netlify")
+- [Next.js](/reference/plugins/next "Next.js")
+- [next-intl](/reference/plugins/next-intl "next-intl")
+- [Next.js MDX](/reference/plugins/next-mdx "Next.js MDX")
+- [Nitro](/reference/plugins/nitro "Nitro")
+- [Node.js](/reference/plugins/node "Node.js")
+- [node-modules-inspector](/reference/plugins/node-modules-inspector "node-modules-inspector")
+- [nodemon](/reference/plugins/nodemon "nodemon")
+- [npm-package-json-lint](/reference/plugins/npm-package-json-lint "npm-package-json-lint")
+- [Nuxt](/reference/plugins/nuxt "Nuxt")
+- [Nx](/reference/plugins/nx "Nx")
+- [nyc](/reference/plugins/nyc "nyc")
+- [oclif](/reference/plugins/oclif "oclif")
+- [Oxlint](/reference/plugins/oxlint "Oxlint")
+- [Parcel](/reference/plugins/parcel "Parcel")
+- [Payload CMS](/reference/plugins/payload "Payload CMS")
+- [Playwright](/reference/plugins/playwright "Playwright")
+- [Playwright for components](/reference/plugins/playwright-ct "Playwright for components")
+- [playwright-test](/reference/plugins/playwright-test "playwright-test")
+- [Plop](/reference/plugins/plop "Plop")
+- [pm2](/reference/plugins/pm2 "pm2")
+- [pnpm](/reference/plugins/pnpm "pnpm")
+- [PostCSS](/reference/plugins/postcss "PostCSS")
+- [Preconstruct](/reference/plugins/preconstruct "Preconstruct")
+- [Prettier](/reference/plugins/prettier "Prettier")
+- [Prisma](/reference/plugins/prisma "Prisma")
+- [Qwik](/reference/plugins/qwik "Qwik")
+- [React Cosmos](/reference/plugins/react-cosmos "React Cosmos")
+- [React Native](/reference/plugins/react-native "React Native")
+- [React Router](/reference/plugins/react-router "React Router")
+- [Relay](/reference/plugins/relay "Relay")
+- [Release It!](/reference/plugins/release-it "Release It!")
+- [Remark](/reference/plugins/remark "Remark")
+- [Remix](/reference/plugins/remix "Remix")
+- [Rollup](/reference/plugins/rollup "Rollup")
+- [Rsbuild](/reference/plugins/rsbuild "Rsbuild")
+- [Rslib](/reference/plugins/rslib "Rslib")
+- [Rspack](/reference/plugins/rspack "Rspack")
+- [Rstest](/reference/plugins/rstest "Rstest")
+- [Semantic Release](/reference/plugins/semantic-release "Semantic Release")
+- [Sentry](/reference/plugins/sentry "Sentry")
+- [simple-git-hooks](/reference/plugins/simple-git-hooks "simple-git-hooks")
+- [size-limit](/reference/plugins/size-limit "size-limit")
+- [SST](/reference/plugins/sst "SST")
+- [Starlight](/reference/plugins/starlight "Starlight")
+- [Storybook](/reference/plugins/storybook "Storybook")
+- [Stryker](/reference/plugins/stryker "Stryker")
+- [Stylelint](/reference/plugins/stylelint "Stylelint")
+- [Svelte](/reference/plugins/svelte "Svelte")
+- [SvelteKit](/reference/plugins/sveltekit "SvelteKit")
+- [SVGO](/reference/plugins/svgo "SVGO")
+- [SVGR](/reference/plugins/svgr "SVGR")
+- [SWC](/reference/plugins/swc "SWC")
+- [Syncpack](/reference/plugins/syncpack "Syncpack")
+- [Tailwind](/reference/plugins/tailwind "Tailwind")
+- [TanStack Router](/reference/plugins/tanstack-router "TanStack Router")
+- [Taskfile](/reference/plugins/taskfile "Taskfile")
+- [Travis CI](/reference/plugins/travis "Travis CI")
+- [ts-node](/reference/plugins/ts-node "ts-node")
+- [tsdown](/reference/plugins/tsdown "tsdown")
+- [tsup](/reference/plugins/tsup "tsup")
+- [tsx](/reference/plugins/tsx "tsx")
+- [TypeDoc](/reference/plugins/typedoc "TypeDoc")
+- [TypeScript](/reference/plugins/typescript "TypeScript")
+- [unbuild](/reference/plugins/unbuild "unbuild")
+- [UnoCSS](/reference/plugins/unocss "UnoCSS")
+- [Vercel OG](/reference/plugins/vercel-og "Vercel OG")
+- [Vike](/reference/plugins/vike "Vike")
+- [Vite](/reference/plugins/vite "Vite")
+- [VitePress](/reference/plugins/vitepress "VitePress")
+- [Vitest](/reference/plugins/vitest "Vitest")
+- [Vue](/reference/plugins/vue "Vue")
+- [WebdriverIO](/reference/plugins/webdriver-io "WebdriverIO")
+- [webpack](/reference/plugins/webpack "webpack")
+- [Wireit](/reference/plugins/wireit "Wireit")
+- [Wrangler](/reference/plugins/wrangler "Wrangler")
+- [xo](/reference/plugins/xo "xo")
+- [Yarn](/reference/plugins/yarn "Yarn")
+- [yorkie](/reference/plugins/yorkie "yorkie")
+- [zx](/reference/plugins/zx "zx")
+
+
+:::

package/src/docs/docs/reference/related-tooling.md

@@ -0,0 +1,46 @@
+---
+title: Related Tooling
+---
+
+This is an overview of related tooling for features Knip does not support.
+
+## Unused imports & variables
+
+Knip doesn't look for unused imports and variables within a file. The focus is
+on exported values and types across files.
+
+Use [ESLint][1], [Biome][2] or [oxlint][3] to find unused variables within
+files.
+
+Use [remove-unused-vars][4] to remove unused code within files, but in a more
+valiant way. Using input from any of the above linters, it actually removes a
+lot more unused code. This pairs great with Knip.
+
+## Unused properties
+
+Knip does not yet support finding unused members of types, interfaces and
+objects. This includes returned objects from exported functions and objects
+passed as React component props.
+
+Knip does support finding unused members of enums and classes, and exported
+values and types on imported namespaces.
+
+## Circular dependencies
+
+Knip has no issues with circular dependencies, and does not report them. Tools
+that do support this include [DPDM][5], [Madge][6] and [skott][7].
+
+## Cleanup
+
+The [e18e.dev][8] website and in particular the [Cleanup][9] section is a great
+resource when dealing with technical debt.
+
+[1]: https://eslint.org
+[2]: https://biomejs.dev/linter/
+[3]: https://oxc.rs/docs/guide/usage/linter.html
+[4]: https://github.com/webpro-nl/remove-unused-vars
+[5]: https://github.com/acrazing/dpdm
+[6]: https://github.com/pahen/madge
+[7]: https://github.com/antoine-coulon/skott
+[8]: https://e18e.dev
+[9]: https://e18e.dev/guide/cleanup.html

package/src/docs/docs/sponsors.mdx

@@ -0,0 +1,64 @@
+---
+title: 'Become a sponsor!'
+template: splash
+---
+
+import StarlightPage from '@astrojs/starlight/components/StarlightPage.astro';
+import Posts from '../../components/Posts.astro';
+import Projects from '../../components/Projects.astro';
+import SponsorsComponent from '../../components/Sponsors.astro';
+import SponsorsChart from '../../components/SponsorsChart.astro';
+
+:::article{.prose}
+
+Knip is a powerful tool that helps thousands of developers keep their JavaScript
+and TypeScript projects lean and maintainable. Knip saves teams valuable time
+and resources.
+
+Building and maintaining Knip has been, and remains, a lot of work. Supportive
+resources allow me to focus on maintenance and development of Knip, which is
+[relied upon][1] [by many][2] in the JavaScript community. Please consider
+supporting the project! The following platforms are available to support Knip:
+
+- [GitHub Sponsors][3]
+- [OpenCollective][4]
+
+You or your company logo with a backlink to your website will be added to this
+page if you decide to support the project on an ongoing basis. Eternal gratitude
+to the companies and people supporting the project!
+
+:::
+
+<SponsorsComponent showAll={true} />
+
+## Monthly Overview
+
+Overview of gross GitHub and OpenCollective sponsorships and invoices, starting
+from the moment the project openly asked for support. Actual development started
+one year before that.
+
+<SponsorsChart />
+
+- The monthly aggregated average over the charted period is $513.
+- The monthly recurring average without one-time payments is $350.
+- GitHub Sponsors is for my GitHub account. This has more repositories, but in
+  practice targets mostly Knip (and perhaps some [release-it][5]).
+- [Chart generated][6] using [Venz][7].
+
+## Trusted by the world's best software teams
+
+<section class="columns min300">
+  <Projects />
+</section>
+
+## Don't just take our word for it
+
+<Posts />
+
+[1]: #trusted-by-the-worlds-best-software-teams
+[2]: https://github.com/webpro-nl/knip/network/dependents
+[3]: https://github.com/sponsors/webpro
+[4]: https://opencollective.com/knip
+[5]: https://github.com/release-it/release-it
+[6]: https://try.venz.dev?type=pivot&lp=tr&br=0&labelX=month&labelY=amount+\($\)&l=GitHub+Sponsors&color=%23fbfbfb&l=Open+Collective&color=%232487ff&label=2023-11&data=9,0&label=2023-12&data=74,0&label=2024-01&data=239,0&label=2024-02&data=489,0&label=2024-03&data=189,0&label=2024-04&data=204,750&label=2024-05&data=304,101&label=2024-06&data=1204,0&label=2024-07&data=204,35&label=2024-08&data=229,25&label=2024-09&data=2729,25&label=2024-10&data=410,45&label=2024-11&data=222,45&label=2024-12&data=222,145&label=2025-01&data=342,145&label=2025-02&data=244,145&label=2025-03&data=222,145&label=2025-04&data=222,145&label=2025-05&data=242,145&label=2025-06&data=247,145&label=2025-07&data=297,145&label=2025-08&data=268,145&label=2025-09&data=350,145&label=2025-10&data=375,145&label=2025-11&data=549,145&label=2025-12&data=355,145
+[7]: https://try.venz.dev

package/src/docs/docs/typescript/unused-dependencies.md

@@ -0,0 +1,86 @@
+---
+title: Unused dependencies
+description: Find and remove unused dependencies with Knip
+prev: false
+next: false
+---
+
+One of Knip's core features is finding unused dependencies in your JavaScript
+and TypeScript projects. And it comes with many more features to remove clutter
+and keep your projects in great shape.
+
+## Why are unused dependencies a problem?
+
+Having unused dependencies in your `package.json` is an issue for various
+reasons:
+
+- They might end up in the final production bundle, increasing size and load
+  times for end users.
+- They waste space in `node_modules` and add to the installation time of the
+  project.
+- They slow down tooling such as linters and bundlers that analyze dependencies.
+- They are confusing and noisy in `package.json`.
+- They cause unnecessary extra work when managing and upgrading dependencies.
+- They can cause version conflicts with other dependencies in use.
+- They can cause false security alerts.
+- They might have restrictive licenses and make your project subject to theirs.
+- They usually come with transitive dependencies that have the same issues.
+
+## How do I find unused dependencies?
+
+Use Knip to find and remove unused dependencies. It also finds dependencies that
+are missing in `package.json` and has a lot more features to keep your
+JavaScript and TypeScript projects tidy.
+
+It's easy to [get started][1] and make package management easier and more fun!
+
+<div style="display: flex; justify-content: center; margin: 4rem auto;">
+  <img src="/logo.svg" alt="Logo of Knip, to find unused dependencies, exports and files" class="logo-border" />
+</div>
+
+## How does Knip identify unused dependencies?
+
+Knip works by analyzing `package.json` files, source code and configuration
+files for other tooling in the project to find unused and missing dependencies.
+Knip has many heuristics, [plugins][2] and [compilers][3] to fully automate the
+process.
+
+## Can Knip remove unused dependencies?
+
+Yes, Knip can automatically remove unused dependencies installed by a package
+manager like npm or pnpm for you. Add the `--fix` argument to [auto-fix][4] and
+remove unused dependencies from `package.json`.
+
+## Can Knip detect missing dependencies?
+
+Yes, Knip detects missing dependencies. It analyzes `package.json` files, and
+reports packages that are missing. They should be added to `package.json` to
+avoid relying on transitive dependencies that can cause version mismatches and
+breakage.
+
+## Does Knip work with monorepos?
+
+Yes, Knip has first-class support for [monorepos and workspaces][5]. It analyzes
+all workspaces in the project and understands their relationship.
+
+For instance, if a dependency is listed in the root `package.json` it does not
+need to be listed in other workspaces. Except if you enable `--strict` checking.
+
+## Does Knip separate dependencies and devDependencies?
+
+Yes, Knip understands the difference between dependencies and devDependencies.
+It has a [production mode][6] to focus on production code only and find dead
+code and dependencies that would otherwise only be referenced by tests and other
+tooling. This allows you to remove both unused exported code and their tests.
+
+## Does Knip work with my package manager?
+
+Yes, Knip works with any package manager: npm, pnpm, Bun and Yarn are all
+supported. It's easy to [get started][1] with any package manager.
+
+[1]: ../overview/getting-started.mdx
+[2]: ../reference/plugins.md
+[3]: ../features/compilers.md
+[4]: ../features/auto-fix.mdx
+[5]: ../features/monorepos-and-workspaces.md
+[6]: ../features/production-mode.md

package/src/docs/docs/typescript/unused-exports.md

@@ -0,0 +1,87 @@
+---
+title: Unused exports
+description: Find and remove unused exports with Knip
+prev: false
+next: false
+---
+
+Finding unused exports in your JavaScript and TypeScript projects is one of
+Knip's core features. And it comes with even more features to identify and
+remove clutter to keep your projects in great shape.
+
+## Why are unused exports a problem?
+
+Having unused exports in your codebase is problematic for several reasons:
+
+- They increase bundle sizes if not properly eliminated by tree-shaking.
+- They clutter the codebase and make it harder to navigate and understand.
+- They mislead developers into thinking certain code is used when it's not.
+- They make refactoring and maintaining the codebase more difficult.
+- They slow down tooling that analyze the codebase, such as bundlers, linters
+  and type checkers.
+- They may represent dead code that is no longer needed but hasn't been cleaned
+  up.
+
+## How do I find unused exports?
+
+Knip is a powerful tool that can help you find and remove unused exports in your
+JavaScript and TypeScript projects. It analyzes the codebase, identifies exports
+that are not imported anywhere, and reports them.
+
+[Get started and install Knip][1] to run it on your project. Knip will scan your
+files and provide a detailed report of unused exports, and much more.
+
+<div style="display: flex; justify-content: center; margin: 4rem auto;">
+  <img src="/logo.svg" alt="Logo of Knip, to find unused dependencies, exports and files" class="logo-border" />
+</div>
+
+## How does Knip identify unused exports?
+
+Knip performs both static and dynamic analysis to determine which exports are
+actually being used in your codebase. It looks at import statements, export
+usage, and [a lot more code patterns][2] to identify unused exports.
+
+Knip supports JavaScript and TypeScript projects, and handles both [CommonJS][3]
+and ES Modules syntax.
+
+## Can Knip remove unused exports?
+
+Yes, Knip not only finds unused exports but can also remove them for you. Run
+Knip with the `--fix` flag to enable [the auto-fix feature][4], and it will
+modify your source code and remove the unused exports.
+
+It's always recommended to review the changes made by Knip before committing
+them to ensure no unintended modifications were made.
+
+## Can Knip handle large codebases?
+
+Absolutely. Knip supports [monorepos with workspaces][5] and utilizes [workspace
+sharing][6] to efficiently analyze large monorepos. This makes it easier and
+more fun to manage and optimize large multi-package projects.
+
+## Does Knip work with my favorite editor or IDE?
+
+Knip is a command-line tool that runs independently of your editor or IDE.
+However, if you run Knip inside an integrated IDE terminal, the report contains
+file names and positions in a format IDEs like VS Code and WebStorm understand
+to easily navigate around.
+
+## How is Knip different from ESLint for finding unused exports?
+
+While linters like ESLint can find unused imports and variables within
+individual files, Knip analyzes the entire project to determine which exports
+are actually unused. By building [a comprehensive module graph][7], Knip
+identifies exports that are not imported or used anywhere in the codebase. This
+allows Knip to catch unused exports and dead code that ESLint and other linters
+would miss.
+
+Also see [Why isn't Knip an ESLint plugin?][8]
+
+[1]: ../overview/getting-started.mdx
+[2]: ../reference/faq.md#what-does-knip-look-for-in-source-files
+[3]: ../guides/working-with-commonjs.md
+[4]: ../features/auto-fix.mdx
+[5]: ../features/monorepos-and-workspaces.md
+[6]: ../guides/performance.md#workspace-sharing
+[7]: ../reference/faq.md#whats-in-the-graphs
+[8]: ../reference/faq.md#why-isnt-knip-an-eslint-plugin