Quickstart

This guide streamlines your first end‑to‑end setup: create a codemods repo, connect GitHub, build a Codemod package with MCP or Studio, test locally, and publish via CI.

1. Create your codemods repository

   Use our migrations template repository to bootstrap a repo in your GitHub organization.

2. Sign in to Codemod

   Sign in to Codemod with GitHub, GitLab, or SSO.

3. Create an organization and install the GitHub App

   1. Create an organization
   2. Install: GitHub → Codemod App
      If the user requesting installation isn’t an org admin, they may see an error. Ask an admin to approve the installation.

   3. Switch context from your personal account to your organization account.
4. Create an API key

   From your organization settings, create an API key.

   In your GitHub repo: Settings → Secrets & variables → Actions → New repository secret CODEMOD_API_KEY

   
5. Build a Codemod package

   You can build a Codemod package that automates a code change your team needs—such as updating an API, renaming components, or refactoring patterns.

   If you’re new to codemods, we recommend using Codemod Studio or Codemod MCP to create your first Codemod package with the help of AI.

   Once you build your Codemod package, you can place it in your codemods repository.

6. Validate & Publish

   Use the included GitHub Action workflow to validate and publish your Codemod package.

   Alternatively, you can run npx codemod workflow validate and npx codemod publish with Codemod CLI.