> ## Documentation Index
> Fetch the complete documentation index at: https://docs.codemod.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Codemod for OSS Maintainers

Framework, library, and SDK builders use codemods to move users to new releases without carrying long-term backward compatibility.

Building and maintaining codemods is hard. It does not scale well, adoption is hard to measure, and feedback is limited.

Codemod gives maintainers an easy way to publish official codemods with each release, accept community contributions, and see how codemods are actually used.

Codemod is already used by projects like React, Node.js, ESLint, Express, Nuxt, and many more.

> [card]
>
> ![Node.js logo](https://mintcdn.com/codemod/gRb6XBlMzDjpVOwP/images/logos/nodejs-dark.svg?fit=max\&auto=format\&n=gRb6XBlMzDjpVOwP\&q=85\&s=f46795075e9654d41813ad58e96ecfb8)
>
> [Open](https://github.com/nodejs/userland-migrations)

> [card]
>
> ![React logo](https://mintcdn.com/codemod/gRb6XBlMzDjpVOwP/images/logos/react-dark-and-light.svg?fit=max\&auto=format\&n=gRb6XBlMzDjpVOwP\&q=85\&s=00e720ab12bc875d6b3929aea623b067)
>
> [Open](https://react.dev/blog/2024/04/25/react-19-upgrade-guide#codemods)

> [card]
>
> ![ESLint logo](https://mintcdn.com/codemod/H2zI4sMoIL05x5kX/images/logos/eslint-dark.svg?fit=max\&auto=format\&n=H2zI4sMoIL05x5kX\&q=85\&s=c1c69685774f9e46b49386b8b24a023b)
>
> [Open](https://github.com/eslint/codemods)

> [card]
>
> ![Webpack logo](https://mintcdn.com/codemod/gRb6XBlMzDjpVOwP/images/logos/webpack-dark.svg?fit=max\&auto=format\&n=gRb6XBlMzDjpVOwP\&q=85\&s=20193743f5117f8eb085976e6e4bed7d)
>
> [Open](https://webpack.js.org/migrate/5/#codemods)

> [card]
>
> ![Nuxt logo](https://mintcdn.com/codemod/gRb6XBlMzDjpVOwP/images/logos/nuxt-dark.svg?fit=max\&auto=format\&n=gRb6XBlMzDjpVOwP\&q=85\&s=83eaf05e4790a3377c3eb63b644745ec)
>
> [Open](https://nuxt.com/docs/4.x/getting-started/upgrade#migrating-using-codemods)

> [card]
>
> ![pnpm logo](https://mintcdn.com/codemod/gRb6XBlMzDjpVOwP/images/logos/pnpm-dark.svg?fit=max\&auto=format\&n=gRb6XBlMzDjpVOwP\&q=85\&s=5f27e5027f24e6176aabd099a2dcfb82)
>
> [Open](https://github.com/pnpm/codemod?tab=readme-ov-file)

> [card]
>
> ![MSW logo](https://mintcdn.com/codemod/H2zI4sMoIL05x5kX/images/logos/msw-dark.svg?fit=max\&auto=format\&n=H2zI4sMoIL05x5kX\&q=85\&s=540db278a65ed3c8adb61a5a2557ff1b)
>
> [Open](https://github.com/mswjs/codemods)

> [card]
>
> ![React Router logo](https://mintcdn.com/codemod/gRb6XBlMzDjpVOwP/images/logos/react-router-dark.svg?fit=max\&auto=format\&n=gRb6XBlMzDjpVOwP\&q=85\&s=1d746aea0b7ffaff0d98f1659a85ac80)
>
> [Open](https://reactrouter.com/upgrading/remix#2-update-dependencies)

## Get started

[Quickstart](https://demo.arcade.software/QEtLo6oVoxUnNNejORqp?embed\&embed_mobile=inline\&embed_desktop=inline\&show_copy_link=true)

**1. Create a dedicated repo to host your codemods**

Scaffold a dedicated repository under your project’s GitHub organization to host official codemods:

```bash theme={null}
npx codemod init --workspace
```

The generated layout:

* keeps shared publishing and repo configuration at the root
* isolates each codemod under `codemods/<slug>/`
* keeps migration logic separate from product code
* gives maintainers a dedicated repo for collaboration and releases under the project scope

See the [ESLint codemods repo](https://github.com/eslint/codemods) for an example.

**2. Secure your official scope**

* Create a free Codemod account and sign in.
* Add your GitHub organization.
* Install the Codemod GitHub App on your codemod repo.

This enables trusted publishing under your org scope from GitHub Actions with no API keys or secrets to manage. See the [Node.js official codemods filtered via scope:nodejs in the registry](https://app.codemod.com/registry?q=scope%3Anodejs) for an example.

**3. Build and publish codemods**

At this point, your repo is fully set up for collaboration and publishing.

* You or your community can open PRs to add or improve codemods.
* Once merged, you can use the GitHub Action to publish the codemod to the registry under your org scope. Make sure codemod names start with your scope (`@your-github-org-name/codemod-name`, for example `@eslint/v8-to-v9-config`).

> [!TIP]
>
> If you do not know how to build or publish codemods yet, check out the following guides:
>
> * [Build your first codemod with MCP](https://docs.codemod.com/community/oss-quickstart.md#2-scaffold-and-build-your-codemod)
> * Use [Codemod Studio](https://docs.codemod.com/enterprise/codemod-studio.md) for:
>   * A live codemod runner
>   * An AST viewer
>   * Shareable links with test fixtures for review and debugging
> * [Publishing codemods](https://docs.codemod.com/community/publishing.md) to the registry.

## Getting help

> [card] [Join the community](https://go.codemod.com/community)
>
> Ask questions, get help, and connect with other framework maintainers on Slack.

> [card] [Book a call](https://cal.com/alexbit)
>
> Schedule a demo or get hands-on help from the Codemod team.

## Next steps

> [card] [CLI](https://docs.codemod.com/community/cli.md)
>
> Learn more about Codemod CLI.

> [card] [Workflows](https://docs.codemod.com/community/workflows)
>
> Orchestrate complex multi-step migrations.

> [card] [JSSG](https://docs.codemod.com/community/jssg)
>
> Learn the transformation engine in depth.

> [card] [Publishing](https://docs.codemod.com/community/publishing.md)
>
> Authentication methods and CI/CD setup.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.