REMOVE THIS SECTION ONCE THE REPO IS SET UP.

Framework/SDK maintainers: This template includes setup guides, utilities, and a GitHub Action to help you and your community build and publish codemods with ease.

One-time setup

Secure a scope for your org

1. Sign up at app.codemod.com with your GitHub account.
2. Install the Codemod app:
   1. Go to app.codemod.com/studio.
   2. In Results, click Select Repo.
   3. Installing the app for a repo in your GitHub org reserves a scope matching your org name.
      • Example: only admins of the nodejs org can publish codemods starting with @nodejs.
      • All official codemods appear in the Registry under that scope.
      • Important: In each codemod.yaml, make sure name starts with your scope.

Authorize GitHub Action

1. Generate an API key at app.codemod.com/api-keys.
2. In your repo: Settings → Secrets and variables → Actions
   1. Create a repository secret:
      • Name: CODEMOD_API_KEY
      • Value: your API key from step 1.

✅ Done! After a codemod PR is merged, you can trigger the GitHub Action to auto-publish it to the Codemod Registry under your org scope. See Node.js codemods for an example.

---

Official <FRAMEWORK_OR_SDK_OR_ORG> codemods to help users adopt new features and handle breaking changes with ease.

Community contributions are welcome and appreciated! Check open issues for codemods to build, or open a new one if something’s missing. See the contribution guide for details.

Running codemods

Caution

Codemods modify code! Run them only on Git-tracked files, and commit or stash changes first.

From the registry

Recommended for the best UX. This downloads the package from the Registry.

npx codemod@latest <codemod-name>

For example:

npx codemod@latest @nodejs/tmpDir-to-tmpdir

From source

npx codemod workflow run -w /path/to/folder/containing/workflow.yaml

Note

By default, codemods run in the current folder. Add -t /target/path to change it.

See the Codemod docs for all CLI commands and options.

Security

See SECURITY.md.

License

MIT