Get started
1
Create a dedicated repo to host your codemods
- We recommend creating a dedicated repository under your project’s GitHub org to host codemods using this repo template.
- Using the included GitHub action, you can easily publish official codemods under your org scope, collaborate with trusted community members without giving access to your main repo, and keep migration logic cleanly separated from product code.
- See the ESLint codemods repo 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 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).
Getting help
Join the community
Ask questions, get help, and connect with other framework maintainers on Slack.
Book a call
Schedule a demo or get hands-on help from the Codemod team.