Skip to main content

​
Run your first codemod

By the end of this guide, you’ll have:
  • Discovered a Codemod package from the registry
  • Created a Campaign that runs the Codemod package on your repository
  • Received a pull request with valuable code changes
1

Discover a Codemod package in the Registry

Browse Codemod Registry to find codemods for your use case.The registry includes Codemod packages for framework upgrades, security patches, API migrations, code modernization patterns, and more.
2

Apply a Codemod package to your repository

Once you’ve found a Codemod package you want to try:
  1. Click Apply to Repository
  2. You’ll be prompted to create a new Campaign using the package you selected
  3. If you’re not signed in, you’ll be prompted to sign in (GitHub, GitLab, or SSO)
To run a codemod without signing in, use the CLI. Each Codemod package’s registry page includes a copy-able command you can run locally.CLI execution is great for local testing and one-off transformations. Campaigns provide centralized tracking, multi-repo orchestration, and team collaboration features.
3

Install the GitHub or GitLab App (if needed)

To run Campaigns on your repositories, Codemod needs access via the GitHub or GitLab integrations. If you haven’t installed either one, you’ll be prompted during Campaign creation.

GitHub

Install the Codemod GitHub App

GitLab

Set up group access tokens
If the user requesting installation isn’t an organization admin, they may see an error. Ask an organization admin to approve the installation.
4

Configure and run your Campaign

In the Campaign creation flow:
  1. Select target repository
  2. Configure parameters (if the codemod supports them)
  3. Name your Campaign
  4. Review, Create, and Run your Campaign
The Campaign will create a pull request with the code changes. You’ll receive a notification when the PR is ready to review.

​
Next Steps

Book a Demo

See first-hand how Codemod fits into your workflow.Discover:
  1. high impact migration opportunities
  2. how to operationalize codemods end-to-end, including authoring, review, rollout, tracking, and ongoing governance at scale
  3. how to reduce the constant burden of codebase maintenance across your organization

​
Advanced Enterprise Features

Once you’re comfortable with the basics, explore these enterprise capabilities to scale your migrations:

Team Management

Add team members to your organization to collaborate on migrations. Invite members and assign roles (Admin, Member, or Viewer) to control access to Campaigns and Insights.Learn more: GitHub Integration or GitLab Integration for detailed instructions on managing team members.

Set up Insights

Create dashboards to track patterns, measure impact, and visualize code transformation progress over time.Learn more: Insights Documentation

Advanced Campaign Features

Leverage powerful Campaign capabilities including parameter editing during runs, manual task approval gates, state management across multiple runs, and matrix strategies for parallel execution.Learn more: Building Workflows covers manual triggers, matrix strategies, state management, and parameters.

Private Registry

Publish organization-specific codemods accessible only to your team. Maintain internal codemods for proprietary patterns, standards, and company-specific transformations.Learn more: Codemod Registry

Project Management Integrations

Connect Jira to sync Campaign progress with your project management tools. Link Campaigns to Jira epics for unified tracking and bidirectional status updates.Learn more: Jira Integration

​
Getting Help

  • Slack Community - Join our Slack Community for support, answers, and help from the Codemod team & community.
  • Contact Us - Visit our contact page for support, questions, or to get in touch with the Codemod team.
If you are a framework or library maintainer looking to build and ship codemods to your community, follow the OSS path in Build & publish codemods under OSS & Community.